Created
March 19, 2020 15:55
-
-
Save vvb/26be250f0b0e2518e35bd80916d62bb8 to your computer and use it in GitHub Desktop.
cisco intersight OAS spec
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# The Intersight OpenAPI specification. | |
# Created on 2020-03-19T03:23:13-07:00 | |
openapi: 3.0.2 | |
info: | |
description: |- | |
Cisco Intersight is a management platform delivered as a service with embedded analytics for your Cisco and | |
3rd party IT infrastructure. This platform offers an intelligent level of management that enables | |
IT organizations to analyze, simplify, and automate their environments in more advanced ways than the prior | |
generations of tools. Cisco Intersight provides an integrated and intuitive management experience for | |
resources in the traditional data center as well as at the edge. With flexible deployment options to address | |
complex security needs, getting started with Intersight is quick and easy. | |
Cisco Intersight has deep integration with Cisco UCS and HyperFlex systems allowing for remote deployment, | |
configuration, and ongoing maintenance. The model-based deployment works for a single system in a remote | |
location or hundreds of systems in a data center and enables rapid, standardized configuration and deployment. | |
It also streamlines maintaining those systems whether you are working with small or very large configurations. | |
The Intersight OpenAPI document defines the complete set of properties that are returned in the | |
HTTP response. From that perspective, a client can expect that no additional properties are returned, | |
unless these properties are explicitly defined in the OpenAPI document. | |
However, when a client uses an older version of the Intersight OpenAPI document, the server may | |
send additional properties because the software is more recent than the client. In that case, the client | |
may receive properties that it does not know about. | |
Some generated SDKs perform a strict validation of the HTTP response body against the OpenAPI document. | |
This document was created on 2020-03-19T03:23:13-07:00. | |
version: 0.0.1-123 | |
title: Cisco Intersight | |
license: | |
name: MIT | |
url: https://opensource.org/licenses/MIT | |
contact: | |
name: Intersight API support | |
url: https://intersight.com/help | |
email: [email protected] | |
externalDocs: | |
url: /apidocs | |
description: Online documentation for the Intersight APIs | |
servers: | |
- url: 'https://{server}/api/v1' | |
variables: | |
server: | |
default: intersight.com # SaaS server | |
description: The Intersight URL for the cloud-based infrastructure management APIs. | |
# Because the cookieAuth applies to all paths globally, we can use the security key at the | |
# root level of the OpenAPI document. However, due to limitations in the generated Python SDK, | |
# the cookieAuth is specified on the operation level. | |
#security: | |
# # Apply cookie auth globally to all operations | |
# - cookieAuth: [] | |
tags: | |
- name: aaa | |
- name: adapter | |
- name: appliance | |
- name: asset | |
- name: bios | |
- name: boot | |
- name: cmrf | |
- name: comm | |
- name: compute | |
- name: cond | |
- name: connector | |
- name: content | |
- name: deviceconnector | |
- name: equipment | |
- name: ether | |
- name: externalsite | |
- name: fault | |
- name: fc | |
- name: feedback | |
- name: firmware | |
- name: forecast | |
- name: graphics | |
- name: hcl | |
- name: hyperflex | |
- name: i18n | |
- name: iaas | |
- name: iam | |
- name: infra | |
- name: inventory | |
- name: ipmioverlan | |
- name: kvm | |
- name: license | |
- name: ls | |
- name: management | |
- name: memory | |
- name: meta | |
- name: mo | |
- name: network | |
- name: networkconfig | |
- name: niaapi | |
- name: niatelemetry | |
- name: ntp | |
- name: onprem | |
- name: organization | |
- name: os | |
- name: pci | |
- name: pkix | |
- name: policy | |
- name: policyinventory | |
- name: port | |
- name: processor | |
- name: recovery | |
- name: resource | |
- name: sdcard | |
- name: sdwan | |
- name: search | |
- name: security | |
- name: server | |
- name: smtp | |
- name: snmp | |
- name: software | |
- name: softwarerepository | |
- name: sol | |
- name: ssh | |
- name: storage | |
- name: syslog | |
- name: tam | |
- name: task | |
- name: telemetry | |
- name: terminal | |
- name: top | |
- name: ucsd | |
- name: views | |
- name: virtualization | |
- name: vmedia | |
- name: vnic | |
- name: workflow | |
- name: x509 | |
paths: | |
/aaa/AuditRecords: | |
get: | |
tags: | |
- aaa | |
summary: Read a 'aaa.AuditRecord' resource. | |
operationId: GetAaaAuditRecordList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.View Audit Logs | |
- READ.aaa.AuditRecord | |
- ROLE.Account Administrator | |
- ROLE.User Access Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'aaa.AuditRecord' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/aaa.AuditRecord.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/aaa/AuditRecords/{Moid}: | |
get: | |
tags: | |
- aaa | |
summary: Read a 'aaa.AuditRecord' resource. | |
operationId: GetAaaAuditRecordByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.View Audit Logs | |
- READ.aaa.AuditRecord | |
- ROLE.Account Administrator | |
- ROLE.User Access Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'aaa.AuditRecord' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/aaa.AuditRecord' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAaaAuditRecordByMoid: | |
operationId: GetAaaAuditRecordByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/aaa/AuditRecords/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/ConfigPolicies: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.ConfigPolicy' resource. | |
operationId: GetAdapterConfigPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.adapter.ConfigPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'adapter.ConfigPolicy' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- adapter | |
summary: Create a 'adapter.ConfigPolicy' resource. | |
operationId: CreateAdapterConfigPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.adapter.ConfigPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'adapter.ConfigPolicy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'adapter.ConfigPolicy' resource was created as requested. The | |
'adapter.ConfigPolicy' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'adapter.ConfigPolicy' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/ConfigPolicies/{Moid}: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.ConfigPolicy' resource. | |
operationId: GetAdapterConfigPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.adapter.ConfigPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'adapter.ConfigPolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- adapter | |
summary: Update a 'adapter.ConfigPolicy' resource. | |
operationId: UpdateAdapterConfigPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.adapter.ConfigPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'adapter.ConfigPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'adapter.ConfigPolicy' resource was modified as requested. The | |
'adapter.ConfigPolicy' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'adapter.ConfigPolicy' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- adapter | |
summary: Update a 'adapter.ConfigPolicy' resource. | |
operationId: PatchAdapterConfigPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.adapter.ConfigPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'adapter.ConfigPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'adapter.ConfigPolicy' resource was patched as requested. The | |
'adapter.ConfigPolicy' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'adapter.ConfigPolicy' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ConfigPolicy' | |
links: | |
GetAdapterConfigPolicyByMoid: | |
operationId: GetAdapterConfigPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- adapter | |
summary: Delete a 'adapter.ConfigPolicy' resource. | |
operationId: DeleteAdapterConfigPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.adapter.ConfigPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/ExtEthInterfaces: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.ExtEthInterface' resource. | |
operationId: GetAdapterExtEthInterfaceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.ExtEthInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'adapter.ExtEthInterface' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/adapter.ExtEthInterface.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/ExtEthInterfaces/{Moid}: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.ExtEthInterface' resource. | |
operationId: GetAdapterExtEthInterfaceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.ExtEthInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'adapter.ExtEthInterface' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.ExtEthInterface' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAdapterExtEthInterfaceByMoid: | |
operationId: GetAdapterExtEthInterfaceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/ExtEthInterfaces/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/HostEthInterfaces: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.HostEthInterface' resource. | |
operationId: GetAdapterHostEthInterfaceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.HostEthInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'adapter.HostEthInterface' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/adapter.HostEthInterface.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/HostEthInterfaces/{Moid}: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.HostEthInterface' resource. | |
operationId: GetAdapterHostEthInterfaceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.HostEthInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'adapter.HostEthInterface' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.HostEthInterface' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAdapterHostEthInterfaceByMoid: | |
operationId: GetAdapterHostEthInterfaceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/HostEthInterfaces/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/HostFcInterfaces: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.HostFcInterface' resource. | |
operationId: GetAdapterHostFcInterfaceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.HostFcInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'adapter.HostFcInterface' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/adapter.HostFcInterface.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/HostFcInterfaces/{Moid}: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.HostFcInterface' resource. | |
operationId: GetAdapterHostFcInterfaceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.HostFcInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'adapter.HostFcInterface' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.HostFcInterface' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAdapterHostFcInterfaceByMoid: | |
operationId: GetAdapterHostFcInterfaceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/HostFcInterfaces/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/HostIscsiInterfaces: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.HostIscsiInterface' resource. | |
operationId: GetAdapterHostIscsiInterfaceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.HostIscsiInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'adapter.HostIscsiInterface' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/adapter.HostIscsiInterface.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/HostIscsiInterfaces/{Moid}: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.HostIscsiInterface' resource. | |
operationId: GetAdapterHostIscsiInterfaceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.HostIscsiInterface | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'adapter.HostIscsiInterface' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.HostIscsiInterface' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAdapterHostIscsiInterfaceByMoid: | |
operationId: GetAdapterHostIscsiInterfaceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/HostIscsiInterfaces/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/Units: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.Unit' resource. | |
operationId: GetAdapterUnitList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.Unit | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'adapter.Unit' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/adapter.Unit.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/adapter/Units/{Moid}: | |
get: | |
tags: | |
- adapter | |
summary: Read a 'adapter.Unit' resource. | |
operationId: GetAdapterUnitByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.adapter.Unit | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'adapter.Unit' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/adapter.Unit' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAdapterUnitByMoid: | |
operationId: GetAdapterUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/adapter/Units/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/Backups: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.Backup' resource. | |
operationId: GetApplianceBackupList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.Backup | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.Backup' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.Backup.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Create a 'appliance.Backup' resource. | |
operationId: CreateApplianceBackup | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.appliance.Backup | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'appliance.Backup' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Backup' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.Backup' resource was created as requested. The 'appliance.Backup' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Backup' | |
links: | |
GetApplianceBackupByMoid: | |
operationId: GetApplianceBackupByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Backups/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.Backup' resource is asynchronously being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Backup' | |
links: | |
GetApplianceBackupByMoid: | |
operationId: GetApplianceBackupByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Backups/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/Backups/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.Backup' resource. | |
operationId: GetApplianceBackupByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.Backup | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.Backup' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Backup' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceBackupByMoid: | |
operationId: GetApplianceBackupByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Backups/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- appliance | |
summary: Delete a 'appliance.Backup' resource. | |
operationId: DeleteApplianceBackup | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.appliance.Backup | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/BackupPolicies: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.BackupPolicy' resource. | |
operationId: GetApplianceBackupPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.BackupPolicy | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.BackupPolicy' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Create a 'appliance.BackupPolicy' resource. | |
operationId: CreateApplianceBackupPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.appliance.BackupPolicy | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'appliance.BackupPolicy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.BackupPolicy' resource was created as requested. The | |
'appliance.BackupPolicy' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.BackupPolicy' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/BackupPolicies/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.BackupPolicy' resource. | |
operationId: GetApplianceBackupPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.BackupPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.BackupPolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.BackupPolicy' resource. | |
operationId: UpdateApplianceBackupPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.appliance.BackupPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.BackupPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.BackupPolicy' resource was modified as requested. The | |
'appliance.BackupPolicy' resource is modified before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.BackupPolicy' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.BackupPolicy' resource. | |
operationId: PatchApplianceBackupPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.appliance.BackupPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.BackupPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.BackupPolicy' resource was patched as requested. The | |
'appliance.BackupPolicy' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.BackupPolicy' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.BackupPolicy' | |
links: | |
GetApplianceBackupPolicyByMoid: | |
operationId: GetApplianceBackupPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/CertificateSettings: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.CertificateSetting' resource. | |
operationId: GetApplianceCertificateSettingList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- READ.appliance.CertificateSetting | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.CertificateSetting' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/CertificateSettings/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.CertificateSetting' resource. | |
operationId: GetApplianceCertificateSettingByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- READ.appliance.CertificateSetting | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.CertificateSetting' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceCertificateSettingByMoid: | |
operationId: GetApplianceCertificateSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.CertificateSetting' resource. | |
operationId: UpdateApplianceCertificateSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.CertificateSetting | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.CertificateSetting' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.CertificateSetting' resource was modified as requested. | |
The 'appliance.CertificateSetting' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
links: | |
GetApplianceCertificateSettingByMoid: | |
operationId: GetApplianceCertificateSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.CertificateSetting' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
links: | |
GetApplianceCertificateSettingByMoid: | |
operationId: GetApplianceCertificateSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.CertificateSetting' resource. | |
operationId: PatchApplianceCertificateSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.CertificateSetting | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.CertificateSetting' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.CertificateSetting' resource was patched as requested. | |
The 'appliance.CertificateSetting' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
links: | |
GetApplianceCertificateSettingByMoid: | |
operationId: GetApplianceCertificateSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.CertificateSetting' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.CertificateSetting' | |
links: | |
GetApplianceCertificateSettingByMoid: | |
operationId: GetApplianceCertificateSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/DataExportPolicies: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.DataExportPolicy' resource. | |
operationId: GetApplianceDataExportPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.DataExportPolicy | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.DataExportPolicy' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Create a 'appliance.DataExportPolicy' resource. | |
operationId: CreateApplianceDataExportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.appliance.DataExportPolicy | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'appliance.DataExportPolicy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DataExportPolicy' resource was created as requested. | |
The 'appliance.DataExportPolicy' resource is created before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DataExportPolicy' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/DataExportPolicies/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.DataExportPolicy' resource. | |
operationId: GetApplianceDataExportPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.DataExportPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.DataExportPolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.DataExportPolicy' resource. | |
operationId: UpdateApplianceDataExportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.appliance.DataExportPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.DataExportPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DataExportPolicy' resource was modified as requested. | |
The 'appliance.DataExportPolicy' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DataExportPolicy' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.DataExportPolicy' resource. | |
operationId: PatchApplianceDataExportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.appliance.DataExportPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.DataExportPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DataExportPolicy' resource was patched as requested. | |
The 'appliance.DataExportPolicy' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DataExportPolicy' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DataExportPolicy' | |
links: | |
GetApplianceDataExportPolicyByMoid: | |
operationId: GetApplianceDataExportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/DeviceClaims: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.DeviceClaim' resource. | |
operationId: GetApplianceDeviceClaimList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Read-Only | |
- READ.appliance.DeviceClaim | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.DeviceClaim' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.DeviceClaim.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Create a 'appliance.DeviceClaim' resource. | |
operationId: CreateApplianceDeviceClaim | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.appliance.DeviceClaim | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'appliance.DeviceClaim' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DeviceClaim' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DeviceClaim' resource was created as requested. The | |
'appliance.DeviceClaim' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DeviceClaim' | |
links: | |
GetApplianceDeviceClaimByMoid: | |
operationId: GetApplianceDeviceClaimByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DeviceClaim' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DeviceClaim' | |
links: | |
GetApplianceDeviceClaimByMoid: | |
operationId: GetApplianceDeviceClaimByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/DeviceClaims/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.DeviceClaim' resource. | |
operationId: GetApplianceDeviceClaimByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Read-Only | |
- READ.appliance.DeviceClaim | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.DeviceClaim' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DeviceClaim' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceDeviceClaimByMoid: | |
operationId: GetApplianceDeviceClaimByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/DiagSettings: | |
post: | |
tags: | |
- appliance | |
summary: Create a 'appliance.DiagSetting' resource. | |
operationId: CreateApplianceDiagSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.appliance.DiagSetting | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'appliance.DiagSetting' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DiagSetting' resource was created as requested. The | |
'appliance.DiagSetting' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DiagSetting' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.DiagSetting' resource. | |
operationId: GetApplianceDiagSettingList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- READ.appliance.DiagSetting | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.DiagSetting' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/DiagSettings/{Moid}: | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.DiagSetting' resource. | |
operationId: UpdateApplianceDiagSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.DiagSetting | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.DiagSetting' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DiagSetting' resource was modified as requested. The | |
'appliance.DiagSetting' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DiagSetting' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.DiagSetting' resource. | |
operationId: PatchApplianceDiagSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.DiagSetting | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.DiagSetting' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.DiagSetting' resource was patched as requested. The | |
'appliance.DiagSetting' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.DiagSetting' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.DiagSetting' resource. | |
operationId: GetApplianceDiagSettingByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- READ.appliance.DiagSetting | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.DiagSetting' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.DiagSetting' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceDiagSettingByMoid: | |
operationId: GetApplianceDiagSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/ImageBundles: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.ImageBundle' resource. | |
operationId: GetApplianceImageBundleList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage API Keys | |
- PRIVSET.Read-Only | |
- READ.appliance.ImageBundle | |
- ROLE.Account Administrator | |
- ROLE.Device Administrator | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.User Access Administrator | |
- ROLE.Virtualization Administrator | |
- ROLE.Workflow Designer | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.ImageBundle' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.ImageBundle.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/ImageBundles/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.ImageBundle' resource. | |
operationId: GetApplianceImageBundleByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage API Keys | |
- PRIVSET.Read-Only | |
- READ.appliance.ImageBundle | |
- ROLE.Account Administrator | |
- ROLE.Device Administrator | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.User Access Administrator | |
- ROLE.Virtualization Administrator | |
- ROLE.Workflow Designer | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.ImageBundle' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.ImageBundle' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceImageBundleByMoid: | |
operationId: GetApplianceImageBundleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/ImageBundles/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/NodeInfos: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.NodeInfo' resource. | |
operationId: GetApplianceNodeInfoList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.NodeInfo | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.NodeInfo' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.NodeInfo.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/NodeInfos/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.NodeInfo' resource. | |
operationId: GetApplianceNodeInfoByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.NodeInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.NodeInfo' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.NodeInfo' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceNodeInfoByMoid: | |
operationId: GetApplianceNodeInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/NodeInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/ReleaseNotes: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.ReleaseNote' resource. | |
operationId: GetApplianceReleaseNoteList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.ReleaseNote | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.ReleaseNote' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.ReleaseNote.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/ReleaseNotes/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.ReleaseNote' resource. | |
operationId: GetApplianceReleaseNoteByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.ReleaseNote | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.ReleaseNote' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.ReleaseNote' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceReleaseNoteByMoid: | |
operationId: GetApplianceReleaseNoteByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/ReleaseNotes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/Restores: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.Restore' resource. | |
operationId: GetApplianceRestoreList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.Restore | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.Restore' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.Restore.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Create a 'appliance.Restore' resource. | |
operationId: CreateApplianceRestore | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.appliance.Restore | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'appliance.Restore' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Restore' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.Restore' resource was created as requested. The 'appliance.Restore' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Restore' | |
links: | |
GetApplianceRestoreByMoid: | |
operationId: GetApplianceRestoreByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Restores/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.Restore' resource is asynchronously being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Restore' | |
links: | |
GetApplianceRestoreByMoid: | |
operationId: GetApplianceRestoreByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Restores/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/Restores/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.Restore' resource. | |
operationId: GetApplianceRestoreByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.Restore | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.Restore' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Restore' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceRestoreByMoid: | |
operationId: GetApplianceRestoreByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Restores/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- appliance | |
summary: Delete a 'appliance.Restore' resource. | |
operationId: DeleteApplianceRestore | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.appliance.Restore | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/SetupInfos: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.SetupInfo' resource. | |
operationId: GetApplianceSetupInfoList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.SetupInfo | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.SetupInfo' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/SetupInfos/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.SetupInfo' resource. | |
operationId: GetApplianceSetupInfoByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.SetupInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.SetupInfo' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceSetupInfoByMoid: | |
operationId: GetApplianceSetupInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.SetupInfo' resource. | |
operationId: UpdateApplianceSetupInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.SetupInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.SetupInfo' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.SetupInfo' resource was modified as requested. The | |
'appliance.SetupInfo' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
links: | |
GetApplianceSetupInfoByMoid: | |
operationId: GetApplianceSetupInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.SetupInfo' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
links: | |
GetApplianceSetupInfoByMoid: | |
operationId: GetApplianceSetupInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.SetupInfo' resource. | |
operationId: PatchApplianceSetupInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.SetupInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.SetupInfo' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.SetupInfo' resource was patched as requested. The 'appliance.SetupInfo' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
links: | |
GetApplianceSetupInfoByMoid: | |
operationId: GetApplianceSetupInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.SetupInfo' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SetupInfo' | |
links: | |
GetApplianceSetupInfoByMoid: | |
operationId: GetApplianceSetupInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/SystemInfos: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.SystemInfo' resource. | |
operationId: GetApplianceSystemInfoList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.SystemInfo | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.SystemInfo' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.SystemInfo.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/SystemInfos/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.SystemInfo' resource. | |
operationId: GetApplianceSystemInfoByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.SystemInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.SystemInfo' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.SystemInfo' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceSystemInfoByMoid: | |
operationId: GetApplianceSystemInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/SystemInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/Upgrades: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.Upgrade' resource. | |
operationId: GetApplianceUpgradeList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.Upgrade | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.Upgrade' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/Upgrades/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.Upgrade' resource. | |
operationId: GetApplianceUpgradeByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.Upgrade | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.Upgrade' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceUpgradeByMoid: | |
operationId: GetApplianceUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.Upgrade' resource. | |
operationId: UpdateApplianceUpgrade | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.appliance.Upgrade | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.Upgrade' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.Upgrade' resource was modified as requested. The 'appliance.Upgrade' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
links: | |
GetApplianceUpgradeByMoid: | |
operationId: GetApplianceUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.Upgrade' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
links: | |
GetApplianceUpgradeByMoid: | |
operationId: GetApplianceUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.Upgrade' resource. | |
operationId: PatchApplianceUpgrade | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.appliance.Upgrade | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.Upgrade' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.Upgrade' resource was patched as requested. The 'appliance.Upgrade' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
links: | |
GetApplianceUpgradeByMoid: | |
operationId: GetApplianceUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.Upgrade' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.Upgrade' | |
links: | |
GetApplianceUpgradeByMoid: | |
operationId: GetApplianceUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/UpgradePolicies: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.UpgradePolicy' resource. | |
operationId: GetApplianceUpgradePolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.UpgradePolicy | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'appliance.UpgradePolicy' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/appliance/UpgradePolicies/{Moid}: | |
get: | |
tags: | |
- appliance | |
summary: Read a 'appliance.UpgradePolicy' resource. | |
operationId: GetApplianceUpgradePolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.appliance.UpgradePolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'appliance.UpgradePolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetApplianceUpgradePolicyByMoid: | |
operationId: GetApplianceUpgradePolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- appliance | |
summary: Update a 'appliance.UpgradePolicy' resource. | |
operationId: UpdateApplianceUpgradePolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.UpgradePolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.UpgradePolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.UpgradePolicy' resource was modified as requested. | |
The 'appliance.UpgradePolicy' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
links: | |
GetApplianceUpgradePolicyByMoid: | |
operationId: GetApplianceUpgradePolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.UpgradePolicy' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
links: | |
GetApplianceUpgradePolicyByMoid: | |
operationId: GetApplianceUpgradePolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- appliance | |
summary: Update a 'appliance.UpgradePolicy' resource. | |
operationId: PatchApplianceUpgradePolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.appliance.UpgradePolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'appliance.UpgradePolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'appliance.UpgradePolicy' resource was patched as requested. The | |
'appliance.UpgradePolicy' resource is patched before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
links: | |
GetApplianceUpgradePolicyByMoid: | |
operationId: GetApplianceUpgradePolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'appliance.UpgradePolicy' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/appliance.UpgradePolicy' | |
links: | |
GetApplianceUpgradePolicyByMoid: | |
operationId: GetApplianceUpgradePolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/ClusterMembers: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.ClusterMember' resource. | |
operationId: GetAssetClusterMemberList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.asset.ClusterMember | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'asset.ClusterMember' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/asset.ClusterMember.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/ClusterMembers/{Moid}: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.ClusterMember' resource. | |
operationId: GetAssetClusterMemberByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.asset.ClusterMember | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'asset.ClusterMember' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ClusterMember' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAssetClusterMemberByMoid: | |
operationId: GetAssetClusterMemberByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ClusterMembers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceClaims: | |
post: | |
tags: | |
- asset | |
summary: Create a 'asset.DeviceClaim' resource. | |
operationId: CreateAssetDeviceClaim | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.asset.DeviceClaim | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'asset.DeviceClaim' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceClaim' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceClaim' resource was created as requested. The 'asset.DeviceClaim' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceClaim' | |
links: | |
GetAssetDeviceClaimByMoid: | |
operationId: GetAssetDeviceClaimByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceClaims/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceClaim' resource is asynchronously being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceClaim' | |
links: | |
GetAssetDeviceClaimByMoid: | |
operationId: GetAssetDeviceClaimByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceClaims/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceClaims/{Moid}: | |
delete: | |
tags: | |
- asset | |
summary: Delete a 'asset.DeviceClaim' resource. | |
operationId: DeleteAssetDeviceClaim | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.asset.DeviceClaim | |
- PRIVSET.Account Administrator | |
- PRIVSET.Delete Devices | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceConfigurations: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceConfiguration' resource. | |
operationId: GetAssetDeviceConfigurationList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.asset.DeviceConfiguration | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'asset.DeviceConfiguration' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceConfigurations/{Moid}: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceConfiguration' resource. | |
operationId: GetAssetDeviceConfigurationByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.asset.DeviceConfiguration | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'asset.DeviceConfiguration' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAssetDeviceConfigurationByMoid: | |
operationId: GetAssetDeviceConfigurationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- asset | |
summary: Update a 'asset.DeviceConfiguration' resource. | |
operationId: UpdateAssetDeviceConfiguration | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.asset.DeviceConfiguration | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.DeviceConfiguration' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceConfiguration' resource was modified as requested. | |
The 'asset.DeviceConfiguration' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
links: | |
GetAssetDeviceConfigurationByMoid: | |
operationId: GetAssetDeviceConfigurationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceConfiguration' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
links: | |
GetAssetDeviceConfigurationByMoid: | |
operationId: GetAssetDeviceConfigurationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- asset | |
summary: Update a 'asset.DeviceConfiguration' resource. | |
operationId: PatchAssetDeviceConfiguration | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.asset.DeviceConfiguration | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.DeviceConfiguration' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceConfiguration' resource was patched as requested. | |
The 'asset.DeviceConfiguration' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
links: | |
GetAssetDeviceConfigurationByMoid: | |
operationId: GetAssetDeviceConfigurationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceConfiguration' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConfiguration' | |
links: | |
GetAssetDeviceConfigurationByMoid: | |
operationId: GetAssetDeviceConfigurationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceConnectorManagers: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceConnectorManager' resource. | |
operationId: GetAssetDeviceConnectorManagerList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Delete Devices | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- READ.asset.DeviceConnectorManager | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'asset.DeviceConnectorManager' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConnectorManager.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceConnectorManagers/{Moid}: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceConnectorManager' resource. | |
operationId: GetAssetDeviceConnectorManagerByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Delete Devices | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- READ.asset.DeviceConnectorManager | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'asset.DeviceConnectorManager' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceConnectorManager' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAssetDeviceConnectorManagerByMoid: | |
operationId: GetAssetDeviceConnectorManagerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceConnectorManagers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceContractInformations: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceContractInformation' resource. | |
operationId: GetAssetDeviceContractInformationList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- PRIVSET.View Servers | |
- READ.asset.DeviceContractInformation | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'asset.DeviceContractInformation' resources for the | |
given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceContractInformations/{Moid}: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceContractInformation' resource. | |
operationId: GetAssetDeviceContractInformationByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- PRIVSET.View Servers | |
- READ.asset.DeviceContractInformation | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'asset.DeviceContractInformation' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAssetDeviceContractInformationByMoid: | |
operationId: GetAssetDeviceContractInformationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- asset | |
summary: Update a 'asset.DeviceContractInformation' resource. | |
operationId: UpdateAssetDeviceContractInformation | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.asset.DeviceContractInformation | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.DeviceContractInformation' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceContractInformation' resource was modified as requested. | |
The 'asset.DeviceContractInformation' resource is modified before this | |
response is sent back and the resource is returned in the body of the | |
message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
links: | |
GetAssetDeviceContractInformationByMoid: | |
operationId: GetAssetDeviceContractInformationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceContractInformation' resource is asynchronously being | |
modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
links: | |
GetAssetDeviceContractInformationByMoid: | |
operationId: GetAssetDeviceContractInformationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- asset | |
summary: Update a 'asset.DeviceContractInformation' resource. | |
operationId: PatchAssetDeviceContractInformation | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- ROLE.Account Administrator | |
- UPDATE.asset.DeviceContractInformation | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.DeviceContractInformation' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceContractInformation' resource was patched as requested. | |
The 'asset.DeviceContractInformation' resource is patched before this | |
response is sent back and the resource is returned in the body of the | |
message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
links: | |
GetAssetDeviceContractInformationByMoid: | |
operationId: GetAssetDeviceContractInformationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceContractInformation' resource is asynchronously being | |
patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceContractInformation' | |
links: | |
GetAssetDeviceContractInformationByMoid: | |
operationId: GetAssetDeviceContractInformationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceRegistrations: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceRegistration' resource. | |
operationId: GetAssetDeviceRegistrationList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Delete Devices | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- PRIVSET.View Servers | |
- READ.asset.DeviceRegistration | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'asset.DeviceRegistration' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/DeviceRegistrations/{Moid}: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.DeviceRegistration' resource. | |
operationId: GetAssetDeviceRegistrationByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Delete Devices | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- PRIVSET.View Servers | |
- READ.asset.DeviceRegistration | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'asset.DeviceRegistration' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAssetDeviceRegistrationByMoid: | |
operationId: GetAssetDeviceRegistrationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- asset | |
summary: Deletes the resource representing the device connector. All associated | |
REST resources will be deleted. In particular, inventory and operational data | |
associated with this device will be deleted. | |
operationId: DeleteAssetDeviceRegistration | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.asset.DeviceRegistration | |
- PRIVSET.Delete Devices | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- asset | |
summary: Updates the resource representing the device connector. For example, | |
this can be used to annotate the device connector resource with user-specified | |
tags. | |
operationId: UpdateAssetDeviceRegistration | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- UPDATE.asset.DeviceRegistration | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.DeviceRegistration' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceRegistration' resource was modified as requested. | |
The 'asset.DeviceRegistration' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
links: | |
GetAssetDeviceRegistrationByMoid: | |
operationId: GetAssetDeviceRegistrationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceRegistration' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
links: | |
GetAssetDeviceRegistrationByMoid: | |
operationId: GetAssetDeviceRegistrationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- asset | |
summary: Updates the resource representing the device connector. For example, | |
this can be used to annotate the device connector resource with user-specified | |
tags. | |
operationId: PatchAssetDeviceRegistration | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- UPDATE.asset.DeviceRegistration | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.DeviceRegistration' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.DeviceRegistration' resource was patched as requested. | |
The 'asset.DeviceRegistration' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
links: | |
GetAssetDeviceRegistrationByMoid: | |
operationId: GetAssetDeviceRegistrationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.DeviceRegistration' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.DeviceRegistration' | |
links: | |
GetAssetDeviceRegistrationByMoid: | |
operationId: GetAssetDeviceRegistrationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/ManagedDevices: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.ManagedDevice' resource. | |
operationId: GetAssetManagedDeviceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Delete Devices | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- READ.asset.ManagedDevice | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'asset.ManagedDevice' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- asset | |
summary: Create a 'asset.ManagedDevice' resource. | |
operationId: CreateAssetManagedDevice | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.asset.ManagedDevice | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'asset.ManagedDevice' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.ManagedDevice' resource was created as requested. The 'asset.ManagedDevice' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.ManagedDevice' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/asset/ManagedDevices/{Moid}: | |
get: | |
tags: | |
- asset | |
summary: Read a 'asset.ManagedDevice' resource. | |
operationId: GetAssetManagedDeviceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- PRIVSET.Delete Devices | |
- PRIVSET.Read-Only | |
- PRIVSET.View Devices | |
- READ.asset.ManagedDevice | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- ROLE.Device Technician | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
- ROLE.Server Administrator | |
- ROLE.Storage Administrator | |
- ROLE.Virtualization Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'asset.ManagedDevice' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- asset | |
summary: Delete a 'asset.ManagedDevice' resource. | |
operationId: DeleteAssetManagedDevice | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.asset.ManagedDevice | |
- PRIVSET.Account Administrator | |
- PRIVSET.Delete Devices | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- asset | |
summary: Update a 'asset.ManagedDevice' resource. | |
operationId: UpdateAssetManagedDevice | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- UPDATE.asset.ManagedDevice | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.ManagedDevice' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.ManagedDevice' resource was modified as requested. The | |
'asset.ManagedDevice' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.ManagedDevice' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- asset | |
summary: Update a 'asset.ManagedDevice' resource. | |
operationId: PatchAssetManagedDevice | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Claim Devices | |
- ROLE.Account Administrator | |
- ROLE.Device Technician | |
- UPDATE.asset.ManagedDevice | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'asset.ManagedDevice' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'asset.ManagedDevice' resource was patched as requested. The 'asset.ManagedDevice' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'asset.ManagedDevice' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/asset.ManagedDevice' | |
links: | |
GetAssetManagedDeviceByMoid: | |
operationId: GetAssetManagedDeviceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/asset/ManagedDevices/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/bios/BootModes: | |
get: | |
tags: | |
- bios | |
summary: Read a 'bios.BootMode' resource. | |
operationId: GetBiosBootModeList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.bios.BootMode | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'bios.BootMode' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/bios.BootMode.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/bios/BootModes/{Moid}: | |
get: | |
tags: | |
- bios | |
summary: Read a 'bios.BootMode' resource. | |
operationId: GetBiosBootModeByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.bios.BootMode | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'bios.BootMode' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetBiosBootModeByMoid: | |
operationId: GetBiosBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- bios | |
summary: Update a 'bios.BootMode' resource. | |
operationId: UpdateBiosBootMode | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.bios.BootMode | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'bios.BootMode' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.BootMode' resource was modified as requested. The 'bios.BootMode' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
links: | |
GetBiosBootModeByMoid: | |
operationId: GetBiosBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.BootMode' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
links: | |
GetBiosBootModeByMoid: | |
operationId: GetBiosBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- bios | |
summary: Update a 'bios.BootMode' resource. | |
operationId: PatchBiosBootMode | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.bios.BootMode | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'bios.BootMode' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.BootMode' resource was patched as requested. The 'bios.BootMode' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
links: | |
GetBiosBootModeByMoid: | |
operationId: GetBiosBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.BootMode' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.BootMode' | |
links: | |
GetBiosBootModeByMoid: | |
operationId: GetBiosBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/bios/Policies: | |
get: | |
tags: | |
- bios | |
summary: Read a 'bios.Policy' resource. | |
operationId: GetBiosPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.bios.Policy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'bios.Policy' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/bios.Policy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- bios | |
summary: Create a 'bios.Policy' resource. | |
operationId: CreateBiosPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.bios.Policy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'bios.Policy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.Policy' resource was created as requested. The 'bios.Policy' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.Policy' resource is asynchronously being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/bios/Policies/{Moid}: | |
get: | |
tags: | |
- bios | |
summary: Read a 'bios.Policy' resource. | |
operationId: GetBiosPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.bios.Policy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'bios.Policy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- bios | |
summary: Update a 'bios.Policy' resource. | |
operationId: UpdateBiosPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.bios.Policy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'bios.Policy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.Policy' resource was modified as requested. The 'bios.Policy' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.Policy' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- bios | |
summary: Update a 'bios.Policy' resource. | |
operationId: PatchBiosPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.bios.Policy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'bios.Policy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.Policy' resource was patched as requested. The 'bios.Policy' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.Policy' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Policy' | |
links: | |
GetBiosPolicyByMoid: | |
operationId: GetBiosPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- bios | |
summary: Delete a 'bios.Policy' resource. | |
operationId: DeleteBiosPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.bios.Policy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/bios/Units: | |
get: | |
tags: | |
- bios | |
summary: Read a 'bios.Unit' resource. | |
operationId: GetBiosUnitList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.bios.Unit | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'bios.Unit' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/bios.Unit.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/bios/Units/{Moid}: | |
get: | |
tags: | |
- bios | |
summary: Read a 'bios.Unit' resource. | |
operationId: GetBiosUnitByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.bios.Unit | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'bios.Unit' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetBiosUnitByMoid: | |
operationId: GetBiosUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- bios | |
summary: Update a 'bios.Unit' resource. | |
operationId: UpdateBiosUnit | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.bios.Unit | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'bios.Unit' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.Unit' resource was modified as requested. The 'bios.Unit' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
links: | |
GetBiosUnitByMoid: | |
operationId: GetBiosUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.Unit' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
links: | |
GetBiosUnitByMoid: | |
operationId: GetBiosUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- bios | |
summary: Update a 'bios.Unit' resource. | |
operationId: PatchBiosUnit | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.bios.Unit | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'bios.Unit' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'bios.Unit' resource was patched as requested. The 'bios.Unit' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
links: | |
GetBiosUnitByMoid: | |
operationId: GetBiosUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'bios.Unit' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/bios.Unit' | |
links: | |
GetBiosUnitByMoid: | |
operationId: GetBiosUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/boot/DeviceBootModes: | |
get: | |
tags: | |
- boot | |
summary: Read a 'boot.DeviceBootMode' resource. | |
operationId: GetBootDeviceBootModeList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.boot.DeviceBootMode | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'boot.DeviceBootMode' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/boot/DeviceBootModes/{Moid}: | |
get: | |
tags: | |
- boot | |
summary: Read a 'boot.DeviceBootMode' resource. | |
operationId: GetBootDeviceBootModeByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.boot.DeviceBootMode | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'boot.DeviceBootMode' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetBootDeviceBootModeByMoid: | |
operationId: GetBootDeviceBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- boot | |
summary: Update a 'boot.DeviceBootMode' resource. | |
operationId: UpdateBootDeviceBootMode | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.boot.DeviceBootMode | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'boot.DeviceBootMode' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'boot.DeviceBootMode' resource was modified as requested. The | |
'boot.DeviceBootMode' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
links: | |
GetBootDeviceBootModeByMoid: | |
operationId: GetBootDeviceBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'boot.DeviceBootMode' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
links: | |
GetBootDeviceBootModeByMoid: | |
operationId: GetBootDeviceBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- boot | |
summary: Update a 'boot.DeviceBootMode' resource. | |
operationId: PatchBootDeviceBootMode | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.boot.DeviceBootMode | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'boot.DeviceBootMode' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'boot.DeviceBootMode' resource was patched as requested. The 'boot.DeviceBootMode' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
links: | |
GetBootDeviceBootModeByMoid: | |
operationId: GetBootDeviceBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'boot.DeviceBootMode' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.DeviceBootMode' | |
links: | |
GetBootDeviceBootModeByMoid: | |
operationId: GetBootDeviceBootModeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/boot/PrecisionPolicies: | |
get: | |
tags: | |
- boot | |
summary: Read a 'boot.PrecisionPolicy' resource. | |
operationId: GetBootPrecisionPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.boot.PrecisionPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'boot.PrecisionPolicy' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- boot | |
summary: Create a 'boot.PrecisionPolicy' resource. | |
operationId: CreateBootPrecisionPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.boot.PrecisionPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'boot.PrecisionPolicy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'boot.PrecisionPolicy' resource was created as requested. The | |
'boot.PrecisionPolicy' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'boot.PrecisionPolicy' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/boot/PrecisionPolicies/{Moid}: | |
get: | |
tags: | |
- boot | |
summary: Read a 'boot.PrecisionPolicy' resource. | |
operationId: GetBootPrecisionPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.boot.PrecisionPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'boot.PrecisionPolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- boot | |
summary: Update a 'boot.PrecisionPolicy' resource. | |
operationId: UpdateBootPrecisionPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.boot.PrecisionPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'boot.PrecisionPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'boot.PrecisionPolicy' resource was modified as requested. The | |
'boot.PrecisionPolicy' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'boot.PrecisionPolicy' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- boot | |
summary: Update a 'boot.PrecisionPolicy' resource. | |
operationId: PatchBootPrecisionPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.boot.PrecisionPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'boot.PrecisionPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'boot.PrecisionPolicy' resource was patched as requested. The | |
'boot.PrecisionPolicy' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'boot.PrecisionPolicy' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/boot.PrecisionPolicy' | |
links: | |
GetBootPrecisionPolicyByMoid: | |
operationId: GetBootPrecisionPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- boot | |
summary: Delete a 'boot.PrecisionPolicy' resource. | |
operationId: DeleteBootPrecisionPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.boot.PrecisionPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/Blades: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.Blade' resource. | |
operationId: GetComputeBladeList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.compute.Blade | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'compute.Blade' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/compute.Blade.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/Blades/{Moid}: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.Blade' resource. | |
operationId: GetComputeBladeByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.compute.Blade | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'compute.Blade' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetComputeBladeByMoid: | |
operationId: GetComputeBladeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- compute | |
summary: Update a 'compute.Blade' resource. | |
operationId: UpdateComputeBlade | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.Blade | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.Blade' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.Blade' resource was modified as requested. The 'compute.Blade' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
links: | |
GetComputeBladeByMoid: | |
operationId: GetComputeBladeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.Blade' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
links: | |
GetComputeBladeByMoid: | |
operationId: GetComputeBladeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- compute | |
summary: Update a 'compute.Blade' resource. | |
operationId: PatchComputeBlade | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.Blade | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.Blade' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.Blade' resource was patched as requested. The 'compute.Blade' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
links: | |
GetComputeBladeByMoid: | |
operationId: GetComputeBladeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.Blade' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Blade' | |
links: | |
GetComputeBladeByMoid: | |
operationId: GetComputeBladeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/Boards: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.Board' resource. | |
operationId: GetComputeBoardList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.compute.Board | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'compute.Board' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/compute.Board.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/Boards/{Moid}: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.Board' resource. | |
operationId: GetComputeBoardByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.compute.Board | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'compute.Board' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetComputeBoardByMoid: | |
operationId: GetComputeBoardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- compute | |
summary: Update a 'compute.Board' resource. | |
operationId: UpdateComputeBoard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.Board | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.Board' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.Board' resource was modified as requested. The 'compute.Board' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
links: | |
GetComputeBoardByMoid: | |
operationId: GetComputeBoardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.Board' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
links: | |
GetComputeBoardByMoid: | |
operationId: GetComputeBoardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- compute | |
summary: Update a 'compute.Board' resource. | |
operationId: PatchComputeBoard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.Board | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.Board' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.Board' resource was patched as requested. The 'compute.Board' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
links: | |
GetComputeBoardByMoid: | |
operationId: GetComputeBoardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.Board' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.Board' | |
links: | |
GetComputeBoardByMoid: | |
operationId: GetComputeBoardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/PhysicalSummaries: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.PhysicalSummary' resource. | |
operationId: GetComputePhysicalSummaryList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.compute.PhysicalSummary | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'compute.PhysicalSummary' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/compute.PhysicalSummary.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/PhysicalSummaries/{Moid}: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.PhysicalSummary' resource. | |
operationId: GetComputePhysicalSummaryByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.compute.PhysicalSummary | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'compute.PhysicalSummary' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.PhysicalSummary' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetComputePhysicalSummaryByMoid: | |
operationId: GetComputePhysicalSummaryByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/PhysicalSummaries/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/RackUnits: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.RackUnit' resource. | |
operationId: GetComputeRackUnitList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.compute.RackUnit | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'compute.RackUnit' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/RackUnits/{Moid}: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.RackUnit' resource. | |
operationId: GetComputeRackUnitByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.compute.RackUnit | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'compute.RackUnit' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetComputeRackUnitByMoid: | |
operationId: GetComputeRackUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- compute | |
summary: Update a 'compute.RackUnit' resource. | |
operationId: UpdateComputeRackUnit | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.RackUnit | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.RackUnit' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.RackUnit' resource was modified as requested. The 'compute.RackUnit' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
links: | |
GetComputeRackUnitByMoid: | |
operationId: GetComputeRackUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.RackUnit' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
links: | |
GetComputeRackUnitByMoid: | |
operationId: GetComputeRackUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- compute | |
summary: Update a 'compute.RackUnit' resource. | |
operationId: PatchComputeRackUnit | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.RackUnit | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.RackUnit' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.RackUnit' resource was patched as requested. The 'compute.RackUnit' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
links: | |
GetComputeRackUnitByMoid: | |
operationId: GetComputeRackUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.RackUnit' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.RackUnit' | |
links: | |
GetComputeRackUnitByMoid: | |
operationId: GetComputeRackUnitByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/ServerSettings: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.ServerSetting' resource. | |
operationId: GetComputeServerSettingList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.compute.ServerSetting | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'compute.ServerSetting' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/compute/ServerSettings/{Moid}: | |
get: | |
tags: | |
- compute | |
summary: Read a 'compute.ServerSetting' resource. | |
operationId: GetComputeServerSettingByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.compute.ServerSetting | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'compute.ServerSetting' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetComputeServerSettingByMoid: | |
operationId: GetComputeServerSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- compute | |
summary: Update a 'compute.ServerSetting' resource. | |
operationId: UpdateComputeServerSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.ServerSetting | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.ServerSetting' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.ServerSetting' resource was modified as requested. The | |
'compute.ServerSetting' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
links: | |
GetComputeServerSettingByMoid: | |
operationId: GetComputeServerSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.ServerSetting' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
links: | |
GetComputeServerSettingByMoid: | |
operationId: GetComputeServerSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- compute | |
summary: Update a 'compute.ServerSetting' resource. | |
operationId: PatchComputeServerSetting | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.compute.ServerSetting | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'compute.ServerSetting' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'compute.ServerSetting' resource was patched as requested. The | |
'compute.ServerSetting' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
links: | |
GetComputeServerSettingByMoid: | |
operationId: GetComputeServerSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'compute.ServerSetting' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/compute.ServerSetting' | |
links: | |
GetComputeServerSettingByMoid: | |
operationId: GetComputeServerSettingByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/Alarms: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.Alarm' resource. | |
operationId: GetCondAlarmList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.cond.Alarm | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'cond.Alarm' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/cond.Alarm.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/Alarms/{Moid}: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.Alarm' resource. | |
operationId: GetCondAlarmByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.cond.Alarm | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'cond.Alarm' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/cond.Alarm' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetCondAlarmByMoid: | |
operationId: GetCondAlarmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/cond/Alarms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/HclStatuses: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.HclStatus' resource. | |
operationId: GetCondHclStatusList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.cond.HclStatus | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'cond.HclStatus' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/cond.HclStatus.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/HclStatuses/{Moid}: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.HclStatus' resource. | |
operationId: GetCondHclStatusByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.cond.HclStatus | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'cond.HclStatus' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/cond.HclStatus' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetCondHclStatusByMoid: | |
operationId: GetCondHclStatusByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/cond/HclStatuses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/HclStatusDetails: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.HclStatusDetail' resource. | |
operationId: GetCondHclStatusDetailList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.cond.HclStatusDetail | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'cond.HclStatusDetail' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/cond.HclStatusDetail.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/HclStatusDetails/{Moid}: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.HclStatusDetail' resource. | |
operationId: GetCondHclStatusDetailByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.cond.HclStatusDetail | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'cond.HclStatusDetail' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/cond.HclStatusDetail' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetCondHclStatusDetailByMoid: | |
operationId: GetCondHclStatusDetailByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/cond/HclStatusDetails/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/HclStatusJobs: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.HclStatusJob' resource. | |
operationId: GetCondHclStatusJobList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.cond.HclStatusJob | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'cond.HclStatusJob' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/cond.HclStatusJob.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/cond/HclStatusJobs/{Moid}: | |
get: | |
tags: | |
- cond | |
summary: Read a 'cond.HclStatusJob' resource. | |
operationId: GetCondHclStatusJobByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.cond.HclStatusJob | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'cond.HclStatusJob' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/cond.HclStatusJob' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetCondHclStatusJobByMoid: | |
operationId: GetCondHclStatusJobByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/cond/HclStatusJobs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/deviceconnector/Policies: | |
post: | |
tags: | |
- deviceconnector | |
summary: Create a 'deviceconnector.Policy' resource. | |
operationId: CreateDeviceconnectorPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.deviceconnector.Policy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'deviceconnector.Policy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'deviceconnector.Policy' resource was created as requested. The | |
'deviceconnector.Policy' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'deviceconnector.Policy' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
get: | |
tags: | |
- deviceconnector | |
summary: Read a 'deviceconnector.Policy' resource. | |
operationId: GetDeviceconnectorPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.deviceconnector.Policy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'deviceconnector.Policy' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/deviceconnector/Policies/{Moid}: | |
get: | |
tags: | |
- deviceconnector | |
summary: Read a 'deviceconnector.Policy' resource. | |
operationId: GetDeviceconnectorPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View Server Profiles | |
- READ.deviceconnector.Policy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'deviceconnector.Policy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- deviceconnector | |
summary: Update a 'deviceconnector.Policy' resource. | |
operationId: UpdateDeviceconnectorPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.deviceconnector.Policy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'deviceconnector.Policy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'deviceconnector.Policy' resource was modified as requested. The | |
'deviceconnector.Policy' resource is modified before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'deviceconnector.Policy' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- deviceconnector | |
summary: Update a 'deviceconnector.Policy' resource. | |
operationId: PatchDeviceconnectorPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
- UPDATE.deviceconnector.Policy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'deviceconnector.Policy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'deviceconnector.Policy' resource was patched as requested. The | |
'deviceconnector.Policy' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'deviceconnector.Policy' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/deviceconnector.Policy' | |
links: | |
GetDeviceconnectorPolicyByMoid: | |
operationId: GetDeviceconnectorPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- deviceconnector | |
summary: Delete a 'deviceconnector.Policy' resource. | |
operationId: DeleteDeviceconnectorPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.deviceconnector.Policy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Chasses: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Chassis' resource. | |
operationId: GetEquipmentChassisList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.Chassis | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.Chassis' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Chasses/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Chassis' resource. | |
operationId: GetEquipmentChassisByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.Chassis | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.Chassis' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentChassisByMoid: | |
operationId: GetEquipmentChassisByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Chassis' resource. | |
operationId: UpdateEquipmentChassis | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Chassis | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Chassis' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Chassis' resource was modified as requested. The 'equipment.Chassis' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
links: | |
GetEquipmentChassisByMoid: | |
operationId: GetEquipmentChassisByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Chassis' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
links: | |
GetEquipmentChassisByMoid: | |
operationId: GetEquipmentChassisByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Chassis' resource. | |
operationId: PatchEquipmentChassis | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Chassis | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Chassis' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Chassis' resource was patched as requested. The 'equipment.Chassis' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
links: | |
GetEquipmentChassisByMoid: | |
operationId: GetEquipmentChassisByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Chassis' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Chassis' | |
links: | |
GetEquipmentChassisByMoid: | |
operationId: GetEquipmentChassisByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/DeviceSummaries: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.DeviceSummary' resource. | |
operationId: GetEquipmentDeviceSummaryList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.equipment.DeviceSummary | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.DeviceSummary' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.DeviceSummary.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/DeviceSummaries/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.DeviceSummary' resource. | |
operationId: GetEquipmentDeviceSummaryByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Server Profiles | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Server Profiles | |
- PRIVSET.View Servers | |
- READ.equipment.DeviceSummary | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.DeviceSummary' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.DeviceSummary' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentDeviceSummaryByMoid: | |
operationId: GetEquipmentDeviceSummaryByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/DeviceSummaries/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Fans: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Fan' resource. | |
operationId: GetEquipmentFanList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.Fan | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.Fan' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.Fan.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Fans/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Fan' resource. | |
operationId: GetEquipmentFanByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.Fan | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.Fan' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentFanByMoid: | |
operationId: GetEquipmentFanByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Fan' resource. | |
operationId: UpdateEquipmentFan | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Fan | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Fan' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Fan' resource was modified as requested. The 'equipment.Fan' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
links: | |
GetEquipmentFanByMoid: | |
operationId: GetEquipmentFanByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Fan' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
links: | |
GetEquipmentFanByMoid: | |
operationId: GetEquipmentFanByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Fan' resource. | |
operationId: PatchEquipmentFan | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Fan | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Fan' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Fan' resource was patched as requested. The 'equipment.Fan' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
links: | |
GetEquipmentFanByMoid: | |
operationId: GetEquipmentFanByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Fan' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fan' | |
links: | |
GetEquipmentFanByMoid: | |
operationId: GetEquipmentFanByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/FanModules: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.FanModule' resource. | |
operationId: GetEquipmentFanModuleList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.FanModule | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.FanModule' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/FanModules/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.FanModule' resource. | |
operationId: GetEquipmentFanModuleByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.FanModule | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.FanModule' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentFanModuleByMoid: | |
operationId: GetEquipmentFanModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.FanModule' resource. | |
operationId: UpdateEquipmentFanModule | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.FanModule | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.FanModule' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.FanModule' resource was modified as requested. The | |
'equipment.FanModule' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
links: | |
GetEquipmentFanModuleByMoid: | |
operationId: GetEquipmentFanModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.FanModule' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
links: | |
GetEquipmentFanModuleByMoid: | |
operationId: GetEquipmentFanModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.FanModule' resource. | |
operationId: PatchEquipmentFanModule | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.FanModule | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.FanModule' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.FanModule' resource was patched as requested. The 'equipment.FanModule' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
links: | |
GetEquipmentFanModuleByMoid: | |
operationId: GetEquipmentFanModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.FanModule' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.FanModule' | |
links: | |
GetEquipmentFanModuleByMoid: | |
operationId: GetEquipmentFanModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Fexes: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Fex' resource. | |
operationId: GetEquipmentFexList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.equipment.Fex | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.Fex' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.Fex.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Fexes/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Fex' resource. | |
operationId: GetEquipmentFexByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.equipment.Fex | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.Fex' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentFexByMoid: | |
operationId: GetEquipmentFexByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Fex' resource. | |
operationId: UpdateEquipmentFex | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Fex | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Fex' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Fex' resource was modified as requested. The 'equipment.Fex' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
links: | |
GetEquipmentFexByMoid: | |
operationId: GetEquipmentFexByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Fex' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
links: | |
GetEquipmentFexByMoid: | |
operationId: GetEquipmentFexByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Fex' resource. | |
operationId: PatchEquipmentFex | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Fex | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Fex' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Fex' resource was patched as requested. The 'equipment.Fex' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
links: | |
GetEquipmentFexByMoid: | |
operationId: GetEquipmentFexByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Fex' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Fex' | |
links: | |
GetEquipmentFexByMoid: | |
operationId: GetEquipmentFexByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/IoCards: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.IoCard' resource. | |
operationId: GetEquipmentIoCardList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.IoCard | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.IoCard' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/IoCards/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.IoCard' resource. | |
operationId: GetEquipmentIoCardByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.IoCard | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.IoCard' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentIoCardByMoid: | |
operationId: GetEquipmentIoCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.IoCard' resource. | |
operationId: UpdateEquipmentIoCard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.IoCard | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.IoCard' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.IoCard' resource was modified as requested. The 'equipment.IoCard' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
links: | |
GetEquipmentIoCardByMoid: | |
operationId: GetEquipmentIoCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.IoCard' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
links: | |
GetEquipmentIoCardByMoid: | |
operationId: GetEquipmentIoCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.IoCard' resource. | |
operationId: PatchEquipmentIoCard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.IoCard | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.IoCard' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.IoCard' resource was patched as requested. The 'equipment.IoCard' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
links: | |
GetEquipmentIoCardByMoid: | |
operationId: GetEquipmentIoCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.IoCard' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoCard' | |
links: | |
GetEquipmentIoCardByMoid: | |
operationId: GetEquipmentIoCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/IoExpanders: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.IoExpander' resource. | |
operationId: GetEquipmentIoExpanderList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.IoExpander | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.IoExpander' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/IoExpanders/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.IoExpander' resource. | |
operationId: GetEquipmentIoExpanderByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.IoExpander | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.IoExpander' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentIoExpanderByMoid: | |
operationId: GetEquipmentIoExpanderByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.IoExpander' resource. | |
operationId: UpdateEquipmentIoExpander | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.IoExpander | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.IoExpander' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.IoExpander' resource was modified as requested. The | |
'equipment.IoExpander' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
links: | |
GetEquipmentIoExpanderByMoid: | |
operationId: GetEquipmentIoExpanderByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.IoExpander' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
links: | |
GetEquipmentIoExpanderByMoid: | |
operationId: GetEquipmentIoExpanderByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.IoExpander' resource. | |
operationId: PatchEquipmentIoExpander | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.IoExpander | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.IoExpander' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.IoExpander' resource was patched as requested. The | |
'equipment.IoExpander' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
links: | |
GetEquipmentIoExpanderByMoid: | |
operationId: GetEquipmentIoExpanderByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.IoExpander' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.IoExpander' | |
links: | |
GetEquipmentIoExpanderByMoid: | |
operationId: GetEquipmentIoExpanderByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/LocatorLeds: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.LocatorLed' resource. | |
operationId: GetEquipmentLocatorLedList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.LocatorLed | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.LocatorLed' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/LocatorLeds/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.LocatorLed' resource. | |
operationId: GetEquipmentLocatorLedByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.LocatorLed | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.LocatorLed' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentLocatorLedByMoid: | |
operationId: GetEquipmentLocatorLedByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.LocatorLed' resource. | |
operationId: UpdateEquipmentLocatorLed | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.LocatorLed | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.LocatorLed' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.LocatorLed' resource was modified as requested. The | |
'equipment.LocatorLed' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
links: | |
GetEquipmentLocatorLedByMoid: | |
operationId: GetEquipmentLocatorLedByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.LocatorLed' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
links: | |
GetEquipmentLocatorLedByMoid: | |
operationId: GetEquipmentLocatorLedByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.LocatorLed' resource. | |
operationId: PatchEquipmentLocatorLed | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.LocatorLed | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.LocatorLed' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.LocatorLed' resource was patched as requested. The | |
'equipment.LocatorLed' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
links: | |
GetEquipmentLocatorLedByMoid: | |
operationId: GetEquipmentLocatorLedByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.LocatorLed' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.LocatorLed' | |
links: | |
GetEquipmentLocatorLedByMoid: | |
operationId: GetEquipmentLocatorLedByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Psus: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Psu' resource. | |
operationId: GetEquipmentPsuList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.Psu | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.Psu' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.Psu.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Psus/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Psu' resource. | |
operationId: GetEquipmentPsuByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.equipment.Psu | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.Psu' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentPsuByMoid: | |
operationId: GetEquipmentPsuByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Psu' resource. | |
operationId: UpdateEquipmentPsu | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Psu | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Psu' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Psu' resource was modified as requested. The 'equipment.Psu' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
links: | |
GetEquipmentPsuByMoid: | |
operationId: GetEquipmentPsuByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Psu' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
links: | |
GetEquipmentPsuByMoid: | |
operationId: GetEquipmentPsuByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Psu' resource. | |
operationId: PatchEquipmentPsu | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Psu | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Psu' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Psu' resource was patched as requested. The 'equipment.Psu' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
links: | |
GetEquipmentPsuByMoid: | |
operationId: GetEquipmentPsuByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Psu' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Psu' | |
links: | |
GetEquipmentPsuByMoid: | |
operationId: GetEquipmentPsuByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/RackEnclosures: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.RackEnclosure' resource. | |
operationId: GetEquipmentRackEnclosureList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.RackEnclosure | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.RackEnclosure' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/RackEnclosures/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.RackEnclosure' resource. | |
operationId: GetEquipmentRackEnclosureByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.RackEnclosure | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.RackEnclosure' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentRackEnclosureByMoid: | |
operationId: GetEquipmentRackEnclosureByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.RackEnclosure' resource. | |
operationId: UpdateEquipmentRackEnclosure | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.RackEnclosure | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.RackEnclosure' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.RackEnclosure' resource was modified as requested. | |
The 'equipment.RackEnclosure' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
links: | |
GetEquipmentRackEnclosureByMoid: | |
operationId: GetEquipmentRackEnclosureByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.RackEnclosure' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
links: | |
GetEquipmentRackEnclosureByMoid: | |
operationId: GetEquipmentRackEnclosureByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.RackEnclosure' resource. | |
operationId: PatchEquipmentRackEnclosure | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.RackEnclosure | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.RackEnclosure' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.RackEnclosure' resource was patched as requested. The | |
'equipment.RackEnclosure' resource is patched before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
links: | |
GetEquipmentRackEnclosureByMoid: | |
operationId: GetEquipmentRackEnclosureByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.RackEnclosure' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosure' | |
links: | |
GetEquipmentRackEnclosureByMoid: | |
operationId: GetEquipmentRackEnclosureByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/RackEnclosureSlots: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.RackEnclosureSlot' resource. | |
operationId: GetEquipmentRackEnclosureSlotList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.RackEnclosureSlot | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.RackEnclosureSlot' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/RackEnclosureSlots/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.RackEnclosureSlot' resource. | |
operationId: GetEquipmentRackEnclosureSlotByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.RackEnclosureSlot | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.RackEnclosureSlot' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentRackEnclosureSlotByMoid: | |
operationId: GetEquipmentRackEnclosureSlotByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.RackEnclosureSlot' resource. | |
operationId: UpdateEquipmentRackEnclosureSlot | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.RackEnclosureSlot | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.RackEnclosureSlot' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.RackEnclosureSlot' resource was modified as requested. | |
The 'equipment.RackEnclosureSlot' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
links: | |
GetEquipmentRackEnclosureSlotByMoid: | |
operationId: GetEquipmentRackEnclosureSlotByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.RackEnclosureSlot' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
links: | |
GetEquipmentRackEnclosureSlotByMoid: | |
operationId: GetEquipmentRackEnclosureSlotByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.RackEnclosureSlot' resource. | |
operationId: PatchEquipmentRackEnclosureSlot | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.RackEnclosureSlot | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.RackEnclosureSlot' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.RackEnclosureSlot' resource was patched as requested. | |
The 'equipment.RackEnclosureSlot' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
links: | |
GetEquipmentRackEnclosureSlotByMoid: | |
operationId: GetEquipmentRackEnclosureSlotByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.RackEnclosureSlot' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.RackEnclosureSlot' | |
links: | |
GetEquipmentRackEnclosureSlotByMoid: | |
operationId: GetEquipmentRackEnclosureSlotByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/SharedIoModules: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.SharedIoModule' resource. | |
operationId: GetEquipmentSharedIoModuleList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.SharedIoModule | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.SharedIoModule' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/SharedIoModules/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.SharedIoModule' resource. | |
operationId: GetEquipmentSharedIoModuleByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.SharedIoModule | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.SharedIoModule' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentSharedIoModuleByMoid: | |
operationId: GetEquipmentSharedIoModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.SharedIoModule' resource. | |
operationId: UpdateEquipmentSharedIoModule | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.SharedIoModule | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.SharedIoModule' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.SharedIoModule' resource was modified as requested. | |
The 'equipment.SharedIoModule' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
links: | |
GetEquipmentSharedIoModuleByMoid: | |
operationId: GetEquipmentSharedIoModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.SharedIoModule' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
links: | |
GetEquipmentSharedIoModuleByMoid: | |
operationId: GetEquipmentSharedIoModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.SharedIoModule' resource. | |
operationId: PatchEquipmentSharedIoModule | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.SharedIoModule | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.SharedIoModule' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.SharedIoModule' resource was patched as requested. | |
The 'equipment.SharedIoModule' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
links: | |
GetEquipmentSharedIoModuleByMoid: | |
operationId: GetEquipmentSharedIoModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.SharedIoModule' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SharedIoModule' | |
links: | |
GetEquipmentSharedIoModuleByMoid: | |
operationId: GetEquipmentSharedIoModuleByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/SwitchCards: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.SwitchCard' resource. | |
operationId: GetEquipmentSwitchCardList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.equipment.SwitchCard | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.SwitchCard' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/SwitchCards/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.SwitchCard' resource. | |
operationId: GetEquipmentSwitchCardByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.equipment.SwitchCard | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.SwitchCard' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentSwitchCardByMoid: | |
operationId: GetEquipmentSwitchCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.SwitchCard' resource. | |
operationId: UpdateEquipmentSwitchCard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.equipment.SwitchCard | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.SwitchCard' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.SwitchCard' resource was modified as requested. The | |
'equipment.SwitchCard' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
links: | |
GetEquipmentSwitchCardByMoid: | |
operationId: GetEquipmentSwitchCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.SwitchCard' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
links: | |
GetEquipmentSwitchCardByMoid: | |
operationId: GetEquipmentSwitchCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.SwitchCard' resource. | |
operationId: PatchEquipmentSwitchCard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.equipment.SwitchCard | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.SwitchCard' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.SwitchCard' resource was patched as requested. The | |
'equipment.SwitchCard' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
links: | |
GetEquipmentSwitchCardByMoid: | |
operationId: GetEquipmentSwitchCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.SwitchCard' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SwitchCard' | |
links: | |
GetEquipmentSwitchCardByMoid: | |
operationId: GetEquipmentSwitchCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/SystemIoControllers: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.SystemIoController' resource. | |
operationId: GetEquipmentSystemIoControllerList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.SystemIoController | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.SystemIoController' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/SystemIoControllers/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.SystemIoController' resource. | |
operationId: GetEquipmentSystemIoControllerByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.SystemIoController | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.SystemIoController' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentSystemIoControllerByMoid: | |
operationId: GetEquipmentSystemIoControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.SystemIoController' resource. | |
operationId: UpdateEquipmentSystemIoController | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.SystemIoController | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.SystemIoController' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.SystemIoController' resource was modified as requested. | |
The 'equipment.SystemIoController' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
links: | |
GetEquipmentSystemIoControllerByMoid: | |
operationId: GetEquipmentSystemIoControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.SystemIoController' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
links: | |
GetEquipmentSystemIoControllerByMoid: | |
operationId: GetEquipmentSystemIoControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.SystemIoController' resource. | |
operationId: PatchEquipmentSystemIoController | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.SystemIoController | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.SystemIoController' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.SystemIoController' resource was patched as requested. | |
The 'equipment.SystemIoController' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
links: | |
GetEquipmentSystemIoControllerByMoid: | |
operationId: GetEquipmentSystemIoControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.SystemIoController' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.SystemIoController' | |
links: | |
GetEquipmentSystemIoControllerByMoid: | |
operationId: GetEquipmentSystemIoControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Tpms: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Tpm' resource. | |
operationId: GetEquipmentTpmList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.Tpm | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'equipment.Tpm' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/equipment/Tpms/{Moid}: | |
get: | |
tags: | |
- equipment | |
summary: Read a 'equipment.Tpm' resource. | |
operationId: GetEquipmentTpmByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.equipment.Tpm | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'equipment.Tpm' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEquipmentTpmByMoid: | |
operationId: GetEquipmentTpmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Tpm' resource. | |
operationId: UpdateEquipmentTpm | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Tpm | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Tpm' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Tpm' resource was modified as requested. The 'equipment.Tpm' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
links: | |
GetEquipmentTpmByMoid: | |
operationId: GetEquipmentTpmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Tpm' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
links: | |
GetEquipmentTpmByMoid: | |
operationId: GetEquipmentTpmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- equipment | |
summary: Update a 'equipment.Tpm' resource. | |
operationId: PatchEquipmentTpm | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.equipment.Tpm | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'equipment.Tpm' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'equipment.Tpm' resource was patched as requested. The 'equipment.Tpm' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
links: | |
GetEquipmentTpmByMoid: | |
operationId: GetEquipmentTpmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'equipment.Tpm' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/equipment.Tpm' | |
links: | |
GetEquipmentTpmByMoid: | |
operationId: GetEquipmentTpmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/ether/PhysicalPorts: | |
get: | |
tags: | |
- ether | |
summary: Read a 'ether.PhysicalPort' resource. | |
operationId: GetEtherPhysicalPortList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.ether.PhysicalPort | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'ether.PhysicalPort' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/ether/PhysicalPorts/{Moid}: | |
get: | |
tags: | |
- ether | |
summary: Read a 'ether.PhysicalPort' resource. | |
operationId: GetEtherPhysicalPortByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.ether.PhysicalPort | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'ether.PhysicalPort' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetEtherPhysicalPortByMoid: | |
operationId: GetEtherPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- ether | |
summary: Update a 'ether.PhysicalPort' resource. | |
operationId: UpdateEtherPhysicalPort | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.ether.PhysicalPort | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'ether.PhysicalPort' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'ether.PhysicalPort' resource was modified as requested. The 'ether.PhysicalPort' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
links: | |
GetEtherPhysicalPortByMoid: | |
operationId: GetEtherPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'ether.PhysicalPort' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
links: | |
GetEtherPhysicalPortByMoid: | |
operationId: GetEtherPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- ether | |
summary: Update a 'ether.PhysicalPort' resource. | |
operationId: PatchEtherPhysicalPort | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.ether.PhysicalPort | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'ether.PhysicalPort' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'ether.PhysicalPort' resource was patched as requested. The 'ether.PhysicalPort' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
links: | |
GetEtherPhysicalPortByMoid: | |
operationId: GetEtherPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'ether.PhysicalPort' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ether.PhysicalPort' | |
links: | |
GetEtherPhysicalPortByMoid: | |
operationId: GetEtherPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/ether/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/externalsite/Authorizations: | |
post: | |
tags: | |
- externalsite | |
summary: Create a 'externalsite.Authorization' resource. | |
operationId: CreateExternalsiteAuthorization | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.externalsite.Authorization | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'externalsite.Authorization' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'externalsite.Authorization' resource was created as requested. | |
The 'externalsite.Authorization' resource is created before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'externalsite.Authorization' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
get: | |
tags: | |
- externalsite | |
summary: Read a 'externalsite.Authorization' resource. | |
operationId: GetExternalsiteAuthorizationList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.externalsite.Authorization | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'externalsite.Authorization' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/externalsite/Authorizations/{Moid}: | |
post: | |
tags: | |
- externalsite | |
summary: Update a 'externalsite.Authorization' resource. | |
operationId: UpdateExternalsiteAuthorization | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.externalsite.Authorization | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'externalsite.Authorization' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'externalsite.Authorization' resource was modified as requested. | |
The 'externalsite.Authorization' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'externalsite.Authorization' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- externalsite | |
summary: Update a 'externalsite.Authorization' resource. | |
operationId: PatchExternalsiteAuthorization | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.externalsite.Authorization | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'externalsite.Authorization' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'externalsite.Authorization' resource was patched as requested. | |
The 'externalsite.Authorization' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'externalsite.Authorization' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
get: | |
tags: | |
- externalsite | |
summary: Read a 'externalsite.Authorization' resource. | |
operationId: GetExternalsiteAuthorizationByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- READ.externalsite.Authorization | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'externalsite.Authorization' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/externalsite.Authorization' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetExternalsiteAuthorizationByMoid: | |
operationId: GetExternalsiteAuthorizationByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/fault/Instances: | |
get: | |
tags: | |
- fault | |
summary: Read a 'fault.Instance' resource. | |
operationId: GetFaultInstanceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.fault.Instance | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'fault.Instance' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/fault.Instance.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/fault/Instances/{Moid}: | |
get: | |
tags: | |
- fault | |
summary: Read a 'fault.Instance' resource. | |
operationId: GetFaultInstanceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.fault.Instance | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'fault.Instance' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFaultInstanceByMoid: | |
operationId: GetFaultInstanceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- fault | |
summary: Update a 'fault.Instance' resource. | |
operationId: UpdateFaultInstance | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.fault.Instance | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'fault.Instance' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'fault.Instance' resource was modified as requested. The 'fault.Instance' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
links: | |
GetFaultInstanceByMoid: | |
operationId: GetFaultInstanceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'fault.Instance' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
links: | |
GetFaultInstanceByMoid: | |
operationId: GetFaultInstanceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- fault | |
summary: Update a 'fault.Instance' resource. | |
operationId: PatchFaultInstance | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.fault.Instance | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'fault.Instance' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'fault.Instance' resource was patched as requested. The 'fault.Instance' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
links: | |
GetFaultInstanceByMoid: | |
operationId: GetFaultInstanceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'fault.Instance' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fault.Instance' | |
links: | |
GetFaultInstanceByMoid: | |
operationId: GetFaultInstanceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/fc/PhysicalPorts: | |
get: | |
tags: | |
- fc | |
summary: Read a 'fc.PhysicalPort' resource. | |
operationId: GetFcPhysicalPortList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.fc.PhysicalPort | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'fc.PhysicalPort' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/fc/PhysicalPorts/{Moid}: | |
get: | |
tags: | |
- fc | |
summary: Read a 'fc.PhysicalPort' resource. | |
operationId: GetFcPhysicalPortByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- READ.fc.PhysicalPort | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'fc.PhysicalPort' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFcPhysicalPortByMoid: | |
operationId: GetFcPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- fc | |
summary: Update a 'fc.PhysicalPort' resource. | |
operationId: UpdateFcPhysicalPort | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.fc.PhysicalPort | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'fc.PhysicalPort' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'fc.PhysicalPort' resource was modified as requested. The 'fc.PhysicalPort' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
links: | |
GetFcPhysicalPortByMoid: | |
operationId: GetFcPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'fc.PhysicalPort' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
links: | |
GetFcPhysicalPortByMoid: | |
operationId: GetFcPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- fc | |
summary: Update a 'fc.PhysicalPort' resource. | |
operationId: PatchFcPhysicalPort | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- ROLE.Account Administrator | |
- UPDATE.fc.PhysicalPort | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'fc.PhysicalPort' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'fc.PhysicalPort' resource was patched as requested. The 'fc.PhysicalPort' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
links: | |
GetFcPhysicalPortByMoid: | |
operationId: GetFcPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'fc.PhysicalPort' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/fc.PhysicalPort' | |
links: | |
GetFcPhysicalPortByMoid: | |
operationId: GetFcPhysicalPortByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/fc/PhysicalPorts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/feedback/FeedbackPosts: | |
post: | |
tags: | |
- feedback | |
summary: Create a 'feedback.FeedbackPost' resource. | |
operationId: CreateFeedbackFeedbackPost | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.feedback.FeedbackPost | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'feedback.FeedbackPost' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/feedback.FeedbackPost' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'feedback.FeedbackPost' resource was created as requested. The | |
'feedback.FeedbackPost' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/feedback.FeedbackPost' | |
links: | |
GetFeedbackFeedbackPostByMoid: | |
operationId: GetFeedbackFeedbackPostByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'feedback.FeedbackPost' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/feedback.FeedbackPost' | |
links: | |
GetFeedbackFeedbackPostByMoid: | |
operationId: GetFeedbackFeedbackPostByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/Distributables: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.Distributable' resource. | |
operationId: GetFirmwareDistributableList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- READ.firmware.Distributable | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.Distributable' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Create a 'firmware.Distributable' resource. | |
operationId: CreateFirmwareDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.firmware.Distributable | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'firmware.Distributable' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.Distributable' resource was created as requested. The | |
'firmware.Distributable' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.Distributable' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/Distributables/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.Distributable' resource. | |
operationId: GetFirmwareDistributableByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- READ.firmware.Distributable | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.Distributable' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Update a 'firmware.Distributable' resource. | |
operationId: UpdateFirmwareDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.firmware.Distributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.Distributable' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.Distributable' resource was modified as requested. The | |
'firmware.Distributable' resource is modified before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.Distributable' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- firmware | |
summary: Update a 'firmware.Distributable' resource. | |
operationId: PatchFirmwareDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.firmware.Distributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.Distributable' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.Distributable' resource was patched as requested. The | |
'firmware.Distributable' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.Distributable' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Distributable' | |
links: | |
GetFirmwareDistributableByMoid: | |
operationId: GetFirmwareDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- firmware | |
summary: Delete a 'firmware.Distributable' resource. | |
operationId: DeleteFirmwareDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.firmware.Distributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/DriverDistributables: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.DriverDistributable' resource. | |
operationId: GetFirmwareDriverDistributableList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.DriverDistributable | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.DriverDistributable' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Create a 'firmware.DriverDistributable' resource. | |
operationId: CreateFirmwareDriverDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.firmware.DriverDistributable | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'firmware.DriverDistributable' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.DriverDistributable' resource was created as requested. | |
The 'firmware.DriverDistributable' resource is created before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.DriverDistributable' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/DriverDistributables/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.DriverDistributable' resource. | |
operationId: GetFirmwareDriverDistributableByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.DriverDistributable | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.DriverDistributable' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Update a 'firmware.DriverDistributable' resource. | |
operationId: UpdateFirmwareDriverDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.firmware.DriverDistributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.DriverDistributable' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.DriverDistributable' resource was modified as requested. | |
The 'firmware.DriverDistributable' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.DriverDistributable' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- firmware | |
summary: Update a 'firmware.DriverDistributable' resource. | |
operationId: PatchFirmwareDriverDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.firmware.DriverDistributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.DriverDistributable' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.DriverDistributable' resource was patched as requested. | |
The 'firmware.DriverDistributable' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.DriverDistributable' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.DriverDistributable' | |
links: | |
GetFirmwareDriverDistributableByMoid: | |
operationId: GetFirmwareDriverDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- firmware | |
summary: Delete a 'firmware.DriverDistributable' resource. | |
operationId: DeleteFirmwareDriverDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.firmware.DriverDistributable | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/Eulas: | |
post: | |
tags: | |
- firmware | |
summary: Create a 'firmware.Eula' resource. | |
operationId: CreateFirmwareEula | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.firmware.Eula | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'firmware.Eula' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Eula' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.Eula' resource was created as requested. The 'firmware.Eula' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Eula' | |
links: | |
GetFirmwareEulaByMoid: | |
operationId: GetFirmwareEulaByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.Eula' resource is asynchronously being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Eula' | |
links: | |
GetFirmwareEulaByMoid: | |
operationId: GetFirmwareEulaByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.Eula' resource. | |
operationId: GetFirmwareEulaList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- READ.firmware.Eula | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.Eula' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.Eula.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/Eulas/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.Eula' resource. | |
operationId: GetFirmwareEulaByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- READ.firmware.Eula | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.Eula' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Eula' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareEulaByMoid: | |
operationId: GetFirmwareEulaByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/RunningFirmwares: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.RunningFirmware' resource. | |
operationId: GetFirmwareRunningFirmwareList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.firmware.RunningFirmware | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.RunningFirmware' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/RunningFirmwares/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.RunningFirmware' resource. | |
operationId: GetFirmwareRunningFirmwareByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Fabric Interconnects | |
- PRIVSET.View Servers | |
- READ.firmware.RunningFirmware | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.RunningFirmware' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareRunningFirmwareByMoid: | |
operationId: GetFirmwareRunningFirmwareByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Update a 'firmware.RunningFirmware' resource. | |
operationId: UpdateFirmwareRunningFirmware | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.firmware.RunningFirmware | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.RunningFirmware' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.RunningFirmware' resource was modified as requested. | |
The 'firmware.RunningFirmware' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
links: | |
GetFirmwareRunningFirmwareByMoid: | |
operationId: GetFirmwareRunningFirmwareByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.RunningFirmware' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
links: | |
GetFirmwareRunningFirmwareByMoid: | |
operationId: GetFirmwareRunningFirmwareByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- firmware | |
summary: Update a 'firmware.RunningFirmware' resource. | |
operationId: PatchFirmwareRunningFirmware | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Fabric Interconnects | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.firmware.RunningFirmware | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.RunningFirmware' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.RunningFirmware' resource was patched as requested. | |
The 'firmware.RunningFirmware' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
links: | |
GetFirmwareRunningFirmwareByMoid: | |
operationId: GetFirmwareRunningFirmwareByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.RunningFirmware' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.RunningFirmware' | |
links: | |
GetFirmwareRunningFirmwareByMoid: | |
operationId: GetFirmwareRunningFirmwareByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/ServerConfigurationUtilityDistributables: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.ServerConfigurationUtilityDistributable' resource. | |
operationId: GetFirmwareServerConfigurationUtilityDistributableList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.ServerConfigurationUtilityDistributable | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.ServerConfigurationUtilityDistributable' | |
resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Create a 'firmware.ServerConfigurationUtilityDistributable' resource. | |
operationId: CreateFirmwareServerConfigurationUtilityDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.firmware.ServerConfigurationUtilityDistributable | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'firmware.ServerConfigurationUtilityDistributable' resource | |
to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.ServerConfigurationUtilityDistributable' resource was | |
created as requested. The 'firmware.ServerConfigurationUtilityDistributable' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.ServerConfigurationUtilityDistributable' resource is asynchronously | |
being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/ServerConfigurationUtilityDistributables/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.ServerConfigurationUtilityDistributable' resource. | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.ServerConfigurationUtilityDistributable | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.ServerConfigurationUtilityDistributable' | |
resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Update a 'firmware.ServerConfigurationUtilityDistributable' resource. | |
operationId: UpdateFirmwareServerConfigurationUtilityDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.firmware.ServerConfigurationUtilityDistributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.ServerConfigurationUtilityDistributable' resource | |
to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.ServerConfigurationUtilityDistributable' resource was | |
modified as requested. The 'firmware.ServerConfigurationUtilityDistributable' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.ServerConfigurationUtilityDistributable' resource is asynchronously | |
being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- firmware | |
summary: Update a 'firmware.ServerConfigurationUtilityDistributable' resource. | |
operationId: PatchFirmwareServerConfigurationUtilityDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.firmware.ServerConfigurationUtilityDistributable | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'firmware.ServerConfigurationUtilityDistributable' resource | |
to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.ServerConfigurationUtilityDistributable' resource was | |
patched as requested. The 'firmware.ServerConfigurationUtilityDistributable' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.ServerConfigurationUtilityDistributable' resource is asynchronously | |
being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.ServerConfigurationUtilityDistributable' | |
links: | |
GetFirmwareServerConfigurationUtilityDistributableByMoid: | |
operationId: GetFirmwareServerConfigurationUtilityDistributableByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- firmware | |
summary: Delete a 'firmware.ServerConfigurationUtilityDistributable' resource. | |
operationId: DeleteFirmwareServerConfigurationUtilityDistributable | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.firmware.ServerConfigurationUtilityDistributable | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/Upgrades: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.Upgrade' resource. | |
operationId: GetFirmwareUpgradeList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.Upgrade | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.Upgrade' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.Upgrade.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- firmware | |
summary: Create a 'firmware.Upgrade' resource. | |
operationId: CreateFirmwareUpgrade | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.firmware.Upgrade | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'firmware.Upgrade' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Upgrade' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'firmware.Upgrade' resource was created as requested. The 'firmware.Upgrade' | |
resource is created before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Upgrade' | |
links: | |
GetFirmwareUpgradeByMoid: | |
operationId: GetFirmwareUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'firmware.Upgrade' resource is asynchronously being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Upgrade' | |
links: | |
GetFirmwareUpgradeByMoid: | |
operationId: GetFirmwareUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/Upgrades/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.Upgrade' resource. | |
operationId: GetFirmwareUpgradeByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.Upgrade | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.Upgrade' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.Upgrade' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareUpgradeByMoid: | |
operationId: GetFirmwareUpgradeByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- firmware | |
summary: Delete a 'firmware.Upgrade' resource. | |
operationId: DeleteFirmwareUpgrade | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.firmware.Upgrade | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/UpgradeStatuses: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.UpgradeStatus' resource. | |
operationId: GetFirmwareUpgradeStatusList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.UpgradeStatus | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'firmware.UpgradeStatus' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/firmware.UpgradeStatus.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/firmware/UpgradeStatuses/{Moid}: | |
get: | |
tags: | |
- firmware | |
summary: Read a 'firmware.UpgradeStatus' resource. | |
operationId: GetFirmwareUpgradeStatusByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.firmware.UpgradeStatus | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'firmware.UpgradeStatus' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/firmware.UpgradeStatus' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetFirmwareUpgradeStatusByMoid: | |
operationId: GetFirmwareUpgradeStatusByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeStatuses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/forecast/Catalogs: | |
get: | |
tags: | |
- forecast | |
summary: Read a 'forecast.Catalog' resource. | |
operationId: GetForecastCatalogList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.forecast.Catalog | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'forecast.Catalog' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/forecast.Catalog.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/forecast/Catalogs/{Moid}: | |
get: | |
tags: | |
- forecast | |
summary: Read a 'forecast.Catalog' resource. | |
operationId: GetForecastCatalogByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.forecast.Catalog | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'forecast.Catalog' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/forecast.Catalog' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetForecastCatalogByMoid: | |
operationId: GetForecastCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/forecast/Catalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/forecast/Definitions: | |
get: | |
tags: | |
- forecast | |
summary: Read a 'forecast.Definition' resource. | |
operationId: GetForecastDefinitionList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.forecast.Definition | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'forecast.Definition' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/forecast.Definition.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/forecast/Definitions/{Moid}: | |
get: | |
tags: | |
- forecast | |
summary: Read a 'forecast.Definition' resource. | |
operationId: GetForecastDefinitionByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.forecast.Definition | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'forecast.Definition' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/forecast.Definition' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetForecastDefinitionByMoid: | |
operationId: GetForecastDefinitionByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/forecast/Definitions/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/forecast/Instances: | |
get: | |
tags: | |
- forecast | |
summary: Read a 'forecast.Instance' resource. | |
operationId: GetForecastInstanceList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.forecast.Instance | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'forecast.Instance' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/forecast.Instance.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/forecast/Instances/{Moid}: | |
get: | |
tags: | |
- forecast | |
summary: Read a 'forecast.Instance' resource. | |
operationId: GetForecastInstanceByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.forecast.Instance | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'forecast.Instance' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/forecast.Instance' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetForecastInstanceByMoid: | |
operationId: GetForecastInstanceByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/forecast/Instances/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/graphics/Cards: | |
get: | |
tags: | |
- graphics | |
summary: Read a 'graphics.Card' resource. | |
operationId: GetGraphicsCardList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.graphics.Card | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'graphics.Card' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/graphics.Card.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/graphics/Cards/{Moid}: | |
get: | |
tags: | |
- graphics | |
summary: Read a 'graphics.Card' resource. | |
operationId: GetGraphicsCardByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.graphics.Card | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'graphics.Card' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetGraphicsCardByMoid: | |
operationId: GetGraphicsCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- graphics | |
summary: Update a 'graphics.Card' resource. | |
operationId: UpdateGraphicsCard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.graphics.Card | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'graphics.Card' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'graphics.Card' resource was modified as requested. The 'graphics.Card' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
links: | |
GetGraphicsCardByMoid: | |
operationId: GetGraphicsCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'graphics.Card' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
links: | |
GetGraphicsCardByMoid: | |
operationId: GetGraphicsCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- graphics | |
summary: Update a 'graphics.Card' resource. | |
operationId: PatchGraphicsCard | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.graphics.Card | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'graphics.Card' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'graphics.Card' resource was patched as requested. The 'graphics.Card' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
links: | |
GetGraphicsCardByMoid: | |
operationId: GetGraphicsCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'graphics.Card' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Card' | |
links: | |
GetGraphicsCardByMoid: | |
operationId: GetGraphicsCardByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/graphics/Controllers: | |
get: | |
tags: | |
- graphics | |
summary: Read a 'graphics.Controller' resource. | |
operationId: GetGraphicsControllerList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.graphics.Controller | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'graphics.Controller' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/graphics.Controller.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/graphics/Controllers/{Moid}: | |
get: | |
tags: | |
- graphics | |
summary: Read a 'graphics.Controller' resource. | |
operationId: GetGraphicsControllerByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.graphics.Controller | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'graphics.Controller' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetGraphicsControllerByMoid: | |
operationId: GetGraphicsControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- graphics | |
summary: Update a 'graphics.Controller' resource. | |
operationId: UpdateGraphicsController | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.graphics.Controller | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'graphics.Controller' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'graphics.Controller' resource was modified as requested. The | |
'graphics.Controller' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
links: | |
GetGraphicsControllerByMoid: | |
operationId: GetGraphicsControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'graphics.Controller' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
links: | |
GetGraphicsControllerByMoid: | |
operationId: GetGraphicsControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- graphics | |
summary: Update a 'graphics.Controller' resource. | |
operationId: PatchGraphicsController | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- ROLE.Account Administrator | |
- UPDATE.graphics.Controller | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'graphics.Controller' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'graphics.Controller' resource was patched as requested. The 'graphics.Controller' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
links: | |
GetGraphicsControllerByMoid: | |
operationId: GetGraphicsControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'graphics.Controller' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/graphics.Controller' | |
links: | |
GetGraphicsControllerByMoid: | |
operationId: GetGraphicsControllerByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/CompatibilityStatuses: | |
post: | |
tags: | |
- hcl | |
summary: Create a 'hcl.CompatibilityStatus' resource. | |
operationId: CreateHclCompatibilityStatus | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hcl.CompatibilityStatus | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hcl.CompatibilityStatus' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.CompatibilityStatus' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hcl.CompatibilityStatus' resource was created as requested. The | |
'hcl.CompatibilityStatus' resource is created before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.CompatibilityStatus' | |
links: | |
GetHclCompatibilityStatusByMoid: | |
operationId: GetHclCompatibilityStatusByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/CompatibilityStatuses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hcl.CompatibilityStatus' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.CompatibilityStatus' | |
links: | |
GetHclCompatibilityStatusByMoid: | |
operationId: GetHclCompatibilityStatusByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/CompatibilityStatuses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/DriverImages: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.DriverImage' resource. | |
operationId: GetHclDriverImageList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.DriverImage | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hcl.DriverImage' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hcl.DriverImage.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/DriverImages/{Moid}: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.DriverImage' resource. | |
operationId: GetHclDriverImageByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.DriverImage | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hcl.DriverImage' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.DriverImage' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHclDriverImageByMoid: | |
operationId: GetHclDriverImageByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/DriverImages/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/ExemptedCatalogs: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.ExemptedCatalog' resource. | |
operationId: GetHclExemptedCatalogList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- READ.hcl.ExemptedCatalog | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hcl.ExemptedCatalog' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hcl.ExemptedCatalog.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/ExemptedCatalogs/{Moid}: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.ExemptedCatalog' resource. | |
operationId: GetHclExemptedCatalogByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- READ.hcl.ExemptedCatalog | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hcl.ExemptedCatalog' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.ExemptedCatalog' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHclExemptedCatalogByMoid: | |
operationId: GetHclExemptedCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/ExemptedCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/HyperflexSoftwareCompatibilityInfos: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hcl.HyperflexSoftwareCompatibilityInfo | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hcl.HyperflexSoftwareCompatibilityInfo' resources | |
for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hcl | |
summary: Create a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. | |
operationId: CreateHclHyperflexSoftwareCompatibilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hcl.HyperflexSoftwareCompatibilityInfo | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hcl.HyperflexSoftwareCompatibilityInfo' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hcl.HyperflexSoftwareCompatibilityInfo' resource was created | |
as requested. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is | |
created before this response is sent back and the resource is returned | |
in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is asynchronously | |
being created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hcl.HyperflexSoftwareCompatibilityInfo | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hcl.HyperflexSoftwareCompatibilityInfo' | |
resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hcl | |
summary: Update a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. | |
operationId: UpdateHclHyperflexSoftwareCompatibilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.hcl.HyperflexSoftwareCompatibilityInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hcl.HyperflexSoftwareCompatibilityInfo' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hcl.HyperflexSoftwareCompatibilityInfo' resource was modified | |
as requested. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is | |
modified before this response is sent back and the resource is returned | |
in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is asynchronously | |
being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- hcl | |
summary: Update a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. | |
operationId: PatchHclHyperflexSoftwareCompatibilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.hcl.HyperflexSoftwareCompatibilityInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hcl.HyperflexSoftwareCompatibilityInfo' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hcl.HyperflexSoftwareCompatibilityInfo' resource was patched | |
as requested. The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is | |
patched before this response is sent back and the resource is returned | |
in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hcl.HyperflexSoftwareCompatibilityInfo' resource is asynchronously | |
being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo' | |
links: | |
GetHclHyperflexSoftwareCompatibilityInfoByMoid: | |
operationId: GetHclHyperflexSoftwareCompatibilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- hcl | |
summary: Delete a 'hcl.HyperflexSoftwareCompatibilityInfo' resource. | |
operationId: DeleteHclHyperflexSoftwareCompatibilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.hcl.HyperflexSoftwareCompatibilityInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/OperatingSystems: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.OperatingSystem' resource. | |
operationId: GetHclOperatingSystemList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.OperatingSystem | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hcl.OperatingSystem' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hcl.OperatingSystem.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/OperatingSystems/{Moid}: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.OperatingSystem' resource. | |
operationId: GetHclOperatingSystemByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.OperatingSystem | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hcl.OperatingSystem' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.OperatingSystem' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHclOperatingSystemByMoid: | |
operationId: GetHclOperatingSystemByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/OperatingSystems/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/OperatingSystemVendors: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.OperatingSystemVendor' resource. | |
operationId: GetHclOperatingSystemVendorList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.OperatingSystemVendor | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hcl.OperatingSystemVendor' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hcl.OperatingSystemVendor.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/OperatingSystemVendors/{Moid}: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.OperatingSystemVendor' resource. | |
operationId: GetHclOperatingSystemVendorByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.OperatingSystemVendor | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hcl.OperatingSystemVendor' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.OperatingSystemVendor' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHclOperatingSystemVendorByMoid: | |
operationId: GetHclOperatingSystemVendorByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/OperatingSystemVendors/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/ServiceStatuses: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.ServiceStatus' resource. | |
operationId: GetHclServiceStatusList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.ServiceStatus | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hcl.ServiceStatus' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hcl.ServiceStatus.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/ServiceStatuses/{Moid}: | |
get: | |
tags: | |
- hcl | |
summary: Read a 'hcl.ServiceStatus' resource. | |
operationId: GetHclServiceStatusByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- READ.hcl.ServiceStatus | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hcl.ServiceStatus' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.ServiceStatus' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHclServiceStatusByMoid: | |
operationId: GetHclServiceStatusByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/ServiceStatuses/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hcl/SupportedDriverNames: | |
post: | |
tags: | |
- hcl | |
summary: Create a 'hcl.SupportedDriverName' resource. | |
operationId: CreateHclSupportedDriverName | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hcl.SupportedDriverName | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage Servers | |
- PRIVSET.Read-Only | |
- PRIVSET.View Servers | |
- ROLE.Account Administrator | |
- ROLE.HyperFlex Cluster Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hcl.SupportedDriverName' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.SupportedDriverName' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hcl.SupportedDriverName' resource was created as requested. The | |
'hcl.SupportedDriverName' resource is created before this response is | |
sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.SupportedDriverName' | |
links: | |
GetHclSupportedDriverNameByMoid: | |
operationId: GetHclSupportedDriverNameByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/SupportedDriverNames/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hcl.SupportedDriverName' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hcl.SupportedDriverName' | |
links: | |
GetHclSupportedDriverNameByMoid: | |
operationId: GetHclSupportedDriverNameByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hcl/SupportedDriverNames/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/Alarms: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.Alarm' resource. | |
operationId: GetHyperflexAlarmList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.hyperflex.Alarm | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hyperflex.Alarm' resources for the given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hyperflex.Alarm.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/Alarms/{Moid}: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.Alarm' resource. | |
operationId: GetHyperflexAlarmByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.hyperflex.Alarm | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hyperflex.Alarm' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Alarm' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHyperflexAlarmByMoid: | |
operationId: GetHyperflexAlarmByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/Alarms/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/AppCatalogs: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.AppCatalog' resource. | |
operationId: GetHyperflexAppCatalogList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.AppCatalog | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hyperflex.AppCatalog' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Create a 'hyperflex.AppCatalog' resource. | |
operationId: CreateHyperflexAppCatalog | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hyperflex.AppCatalog | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hyperflex.AppCatalog' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.AppCatalog' resource was created as requested. The | |
'hyperflex.AppCatalog' resource is created before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.AppCatalog' resource is asynchronously being created as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/AppCatalogs/{Moid}: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.AppCatalog' resource. | |
operationId: GetHyperflexAppCatalogByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.AppCatalog | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hyperflex.AppCatalog' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.AppCatalog' resource. | |
operationId: UpdateHyperflexAppCatalog | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.hyperflex.AppCatalog | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.AppCatalog' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.AppCatalog' resource was modified as requested. The | |
'hyperflex.AppCatalog' resource is modified before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.AppCatalog' resource is asynchronously being modified as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.AppCatalog' resource. | |
operationId: PatchHyperflexAppCatalog | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- UPDATE.hyperflex.AppCatalog | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.AppCatalog' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.AppCatalog' resource was patched as requested. The | |
'hyperflex.AppCatalog' resource is patched before this response is sent | |
back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.AppCatalog' resource is asynchronously being patched as | |
requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AppCatalog' | |
links: | |
GetHyperflexAppCatalogByMoid: | |
operationId: GetHyperflexAppCatalogByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AppCatalogs/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- hyperflex | |
summary: Delete a 'hyperflex.AppCatalog' resource. | |
operationId: DeleteHyperflexAppCatalog | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.hyperflex.AppCatalog | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/AutoSupportPolicies: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.AutoSupportPolicy' resource. | |
operationId: GetHyperflexAutoSupportPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.AutoSupportPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hyperflex.AutoSupportPolicy' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Create a 'hyperflex.AutoSupportPolicy' resource. | |
operationId: CreateHyperflexAutoSupportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hyperflex.AutoSupportPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hyperflex.AutoSupportPolicy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.AutoSupportPolicy' resource was created as requested. | |
The 'hyperflex.AutoSupportPolicy' resource is created before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.AutoSupportPolicy' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/AutoSupportPolicies/{Moid}: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.AutoSupportPolicy' resource. | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.AutoSupportPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hyperflex.AutoSupportPolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.AutoSupportPolicy' resource. | |
operationId: UpdateHyperflexAutoSupportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.AutoSupportPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.AutoSupportPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.AutoSupportPolicy' resource was modified as requested. | |
The 'hyperflex.AutoSupportPolicy' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.AutoSupportPolicy' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.AutoSupportPolicy' resource. | |
operationId: PatchHyperflexAutoSupportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.AutoSupportPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.AutoSupportPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.AutoSupportPolicy' resource was patched as requested. | |
The 'hyperflex.AutoSupportPolicy' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.AutoSupportPolicy' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.AutoSupportPolicy' | |
links: | |
GetHyperflexAutoSupportPolicyByMoid: | |
operationId: GetHyperflexAutoSupportPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/AutoSupportPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- hyperflex | |
summary: Delete a 'hyperflex.AutoSupportPolicy' resource. | |
operationId: DeleteHyperflexAutoSupportPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.hyperflex.AutoSupportPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/CapabilityInfos: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.CapabilityInfo' resource. | |
operationId: GetHyperflexCapabilityInfoList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.CapabilityInfo | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hyperflex.CapabilityInfo' resources for the given | |
filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Create a 'hyperflex.CapabilityInfo' resource. | |
operationId: CreateHyperflexCapabilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hyperflex.CapabilityInfo | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hyperflex.CapabilityInfo' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.CapabilityInfo' resource was created as requested. | |
The 'hyperflex.CapabilityInfo' resource is created before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.CapabilityInfo' resource is asynchronously being created | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/CapabilityInfos/{Moid}: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.CapabilityInfo' resource. | |
operationId: GetHyperflexCapabilityInfoByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.CapabilityInfo | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hyperflex.CapabilityInfo' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.CapabilityInfo' resource. | |
operationId: UpdateHyperflexCapabilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.CapabilityInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.CapabilityInfo' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.CapabilityInfo' resource was modified as requested. | |
The 'hyperflex.CapabilityInfo' resource is modified before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.CapabilityInfo' resource is asynchronously being modified | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.CapabilityInfo' resource. | |
operationId: PatchHyperflexCapabilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.CapabilityInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.CapabilityInfo' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.CapabilityInfo' resource was patched as requested. | |
The 'hyperflex.CapabilityInfo' resource is patched before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.CapabilityInfo' resource is asynchronously being patched | |
as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.CapabilityInfo' | |
links: | |
GetHyperflexCapabilityInfoByMoid: | |
operationId: GetHyperflexCapabilityInfoByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/CapabilityInfos/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
delete: | |
tags: | |
- hyperflex | |
summary: Delete a 'hyperflex.CapabilityInfo' resource. | |
operationId: DeleteHyperflexCapabilityInfo | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- DELETE.hyperflex.CapabilityInfo | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "Resource has been deleted successfully." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'202': | |
description: "The request has been accepted, the resource is being deleted | |
asynchronously." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/Clusters: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.Cluster' resource. | |
operationId: GetHyperflexClusterList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.hyperflex.Cluster | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hyperflex.Cluster' resources for the given filter | |
criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/Clusters/{Moid}: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.Cluster' resource. | |
operationId: GetHyperflexClusterByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Clusters | |
- READ.hyperflex.Cluster | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hyperflex.Cluster' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHyperflexClusterByMoid: | |
operationId: GetHyperflexClusterByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.Cluster' resource. | |
operationId: UpdateHyperflexCluster | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.Cluster | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.Cluster' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.Cluster' resource was modified as requested. The 'hyperflex.Cluster' | |
resource is modified before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
links: | |
GetHyperflexClusterByMoid: | |
operationId: GetHyperflexClusterByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.Cluster' resource is asynchronously being modified as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
links: | |
GetHyperflexClusterByMoid: | |
operationId: GetHyperflexClusterByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
patch: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.Cluster' resource. | |
operationId: PatchHyperflexCluster | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Clusters | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.Cluster | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.Cluster' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.Cluster' resource was patched as requested. The 'hyperflex.Cluster' | |
resource is patched before this response is sent back and the resource | |
is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
links: | |
GetHyperflexClusterByMoid: | |
operationId: GetHyperflexClusterByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.Cluster' resource is asynchronously being patched as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.Cluster' | |
links: | |
GetHyperflexClusterByMoid: | |
operationId: GetHyperflexClusterByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/Clusters/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/ClusterNetworkPolicies: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.ClusterNetworkPolicy' resource. | |
operationId: GetHyperflexClusterNetworkPolicyList | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.ClusterNetworkPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/filterParam' | |
- $ref: '#/components/parameters/orderbyParam' | |
- $ref: '#/components/parameters/topParam' | |
- $ref: '#/components/parameters/skipParam' | |
- $ref: '#/components/parameters/selectParam' | |
- $ref: '#/components/parameters/expandParam' | |
- $ref: '#/components/parameters/applyParam' | |
- $ref: '#/components/parameters/countParam' | |
- $ref: '#/components/parameters/inlinecountParam' | |
- $ref: '#/components/parameters/atParam' | |
responses: | |
'200': | |
description: "List of 'hyperflex.ClusterNetworkPolicy' resources for the | |
given filter criteria" | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
# Response as JSON document. | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy.List' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Create a 'hyperflex.ClusterNetworkPolicy' resource. | |
operationId: CreateHyperflexClusterNetworkPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- CREATE.hyperflex.ClusterNetworkPolicy | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
parameters: | |
- $ref: '#/components/parameters/IfMatch' | |
- $ref: '#/components/parameters/IfNoneMatch' | |
requestBody: | |
description: The 'hyperflex.ClusterNetworkPolicy' resource to create. | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.ClusterNetworkPolicy' resource was created as requested. | |
The 'hyperflex.ClusterNetworkPolicy' resource is created before this response | |
is sent back and the resource is returned in the body of the message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' | |
links: | |
GetHyperflexClusterNetworkPolicyByMoid: | |
operationId: GetHyperflexClusterNetworkPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'202': | |
description: >- | |
The HTTP 202 status response code indicates that the request has succeeded. | |
The 'hyperflex.ClusterNetworkPolicy' resource is asynchronously being | |
created as requested. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' | |
links: | |
GetHyperflexClusterNetworkPolicyByMoid: | |
operationId: GetHyperflexClusterNetworkPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
/hyperflex/ClusterNetworkPolicies/{Moid}: | |
get: | |
tags: | |
- hyperflex | |
summary: Read a 'hyperflex.ClusterNetworkPolicy' resource. | |
operationId: GetHyperflexClusterNetworkPolicyByMoid | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- PRIVSET.Read-Only | |
- PRIVSET.View HyperFlex Cluster Profiles | |
- READ.hyperflex.ClusterNetworkPolicy | |
- ROLE.Account Administrator | |
- ROLE.Read-Only | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
responses: | |
'200': | |
description: "An instance of the 'hyperflex.ClusterNetworkPolicy' resource." | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
Content-Disposition: | |
$ref: '#/components/headers/Content-Disposition' | |
Content-Length: | |
$ref: '#/components/headers/Content-Length' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' | |
text/csv: | |
# Export data as CSV file. | |
schema: | |
$ref: '#/components/schemas/CsvFile' | |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: | |
# Export data as Excel spreadsheet. | |
schema: | |
$ref: '#/components/schemas/ExcelFile' | |
links: | |
GetHyperflexClusterNetworkPolicyByMoid: | |
operationId: GetHyperflexClusterNetworkPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' parameter in 'GET /api/v1/hyperflex/ClusterNetworkPolicies/{Moid}'. | |
GetIamAccountByMoid: | |
$ref: '#/components/links/GetIamAccountByMoid' | |
GetIamDomainGroupByMoid: | |
$ref: '#/components/links/GetIamDomainGroupByMoid' | |
'400': | |
$ref: '#/components/responses/http_status_400' | |
'401': | |
$ref: '#/components/responses/http_status_401' | |
'403': | |
$ref: '#/components/responses/http_status_403' | |
'404': | |
$ref: '#/components/responses/http_status_404' | |
default: | |
$ref: '#/components/responses/default' | |
post: | |
tags: | |
- hyperflex | |
summary: Update a 'hyperflex.ClusterNetworkPolicy' resource. | |
operationId: UpdateHyperflexClusterNetworkPolicy | |
security: | |
- cookieAuth: [] | |
- http_signature: [] | |
- oAuth2: | |
- PRIVSET.Account Administrator | |
- PRIVSET.Manage HyperFlex Cluster Profiles | |
- ROLE.Account Administrator | |
- UPDATE.hyperflex.ClusterNetworkPolicy | |
parameters: | |
- $ref: '#/components/parameters/moidParam' | |
- $ref: '#/components/parameters/IfMatch' | |
requestBody: | |
description: The 'hyperflex.ClusterNetworkPolicy' resource to update. | |
required: true | |
content: | |
# The order of the content types is important (application/json first) because the OpenAPITools generator | |
# uses the first one in the list. | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' | |
# Content-Type 'application/json-patch+json' is supported in the POST method because some organizations block HTTP PATCH. | |
application/json-patch+json: | |
schema: | |
$ref: '#/components/schemas/PatchDocument' | |
responses: | |
'200': | |
description: >- | |
The HTTP 200 status response code indicates that the request has succeeded | |
and the 'hyperflex.ClusterNetworkPolicy' resource was modified as requested. | |
The 'hyperflex.ClusterNetworkPolicy' resource is modified before this | |
response is sent back and the resource is returned in the body of the | |
message. | |
headers: | |
Set-Cookie: | |
$ref: '#/components/headers/Set-Cookie' | |
x-starship-traceid: | |
$ref: '#/components/headers/x-starship-traceid' | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/hyperflex.ClusterNetworkPolicy' | |
links: | |
GetHyperflexClusterNetworkPolicyByMoid: | |
operationId: GetHyperflexClusterNetworkPolicyByMoid | |
parameters: | |
Moid: '$response.body#/Moid' | |
description: The 'Moid' value returned in the response can be used as | |
the 'Moid' param |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment